From 54eaac94226eec5cfec0897bcfe323f4c8216240 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Fri, 12 May 2023 18:15:22 +0000 Subject: [PATCH] Deployed 0c7a0b3787 to master with MkDocs 1.4.3 and mike 1.1.2 --- master/404.html | 4 +- master/architecture/decisions/index.html | 4 +- ...fac441b0.min.js => bundle.c2be25ad.min.js} | 8 ++-- ....min.js.map => bundle.c2be25ad.min.js.map} | 6 +-- .../Common.Catalog.CatalogCategory/index.html | 4 +- .../Common.Catalog.CatalogEntity/index.html | 4 +- .../Common.Catalog.GeneralEntity/index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../classes/Common.Catalog.WebLink/index.html | 4 +- .../Common.EventBus.EventEmitter/index.html | 4 +- .../classes/Common.LensExtension/index.html | 4 +- .../Common.Store.ExtensionStore/index.html | 4 +- .../classes/Common.Util.Singleton/index.html | 4 +- .../api/classes/Main.Ipc/index.html | 4 +- .../Main.K8sApi.ClusterRole/index.html | 4 +- .../Main.K8sApi.ClusterRoleBinding/index.html | 4 +- .../classes/Main.K8sApi.ConfigMap/index.html | 4 +- .../classes/Main.K8sApi.CronJob/index.html | 4 +- .../index.html | 4 +- .../classes/Main.K8sApi.DaemonSet/index.html | 4 +- .../classes/Main.K8sApi.Deployment/index.html | 4 +- .../classes/Main.K8sApi.Endpoint/index.html | 4 +- .../index.html | 4 +- .../classes/Main.K8sApi.Ingress/index.html | 4 +- .../api/classes/Main.K8sApi.Job/index.html | 4 +- .../classes/Main.K8sApi.KubeEvent/index.html | 4 +- .../classes/Main.K8sApi.KubeObject/index.html | 4 +- .../Main.K8sApi.KubeObjectStore/index.html | 4 +- .../classes/Main.K8sApi.KubeStatus/index.html | 4 +- .../classes/Main.K8sApi.LimitRange/index.html | 4 +- .../classes/Main.K8sApi.Namespace/index.html | 4 +- .../Main.K8sApi.NetworkPolicy/index.html | 4 +- .../api/classes/Main.K8sApi.Node/index.html | 4 +- .../Main.K8sApi.PersistentVolume/index.html | 4 +- .../index.html | 4 +- .../api/classes/Main.K8sApi.Pod/index.html | 4 +- .../index.html | 4 +- .../Main.K8sApi.PriorityClass/index.html | 4 +- .../classes/Main.K8sApi.ReplicaSet/index.html | 4 +- .../Main.K8sApi.ResourceQuota/index.html | 4 +- .../Main.K8sApi.ResourceStack/index.html | 4 +- .../api/classes/Main.K8sApi.Role/index.html | 4 +- .../Main.K8sApi.RoleBinding/index.html | 4 +- .../api/classes/Main.K8sApi.Secret/index.html | 4 +- .../classes/Main.K8sApi.Service/index.html | 4 +- .../Main.K8sApi.ServiceAccount/index.html | 4 +- .../Main.K8sApi.StatefulSet/index.html | 4 +- .../Main.K8sApi.StorageClass/index.html | 4 +- .../api/classes/Main.LensExtension/index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../Renderer.Component.Input/index.html | 4 +- .../Renderer.Component.MenuItem/index.html | 4 +- .../index.html | 4 +- .../Renderer.Component.PageLayout/index.html | 4 +- .../index.html | 4 +- .../Renderer.Component.Slider/index.html | 4 +- .../Renderer.Component.Spinner/index.html | 4 +- .../Renderer.Component.Stepper/index.html | 4 +- .../Renderer.Component.SubTitle/index.html | 4 +- .../classes/Renderer.Component.Tab/index.html | 4 +- .../Renderer.Component.TableCell/index.html | 4 +- .../Renderer.Component.TableHead/index.html | 4 +- .../Renderer.Component.TableRow/index.html | 4 +- .../Renderer.Component.Tabs/index.html | 4 +- .../index.html | 4 +- .../Renderer.Component.Wizard/index.html | 4 +- .../index.html | 4 +- .../Renderer.Component.WizardStep/index.html | 4 +- .../api/classes/Renderer.Ipc/index.html | 4 +- .../index.html | 4 +- .../Renderer.K8sApi.CRDStore/index.html | 4 +- .../index.html | 4 +- .../Renderer.K8sApi.CronJobStore/index.html | 4 +- .../Renderer.K8sApi.DaemonSetStore/index.html | 4 +- .../index.html | 4 +- .../Renderer.K8sApi.EndpointStore/index.html | 4 +- .../Renderer.K8sApi.EventStore/index.html | 4 +- .../Renderer.K8sApi.HPAStore/index.html | 4 +- .../index.html | 4 +- .../Renderer.K8sApi.IngressStore/index.html | 4 +- .../Renderer.K8sApi.JobStore/index.html | 4 +- .../index.html | 4 +- .../Renderer.K8sApi.NamespaceStore/index.html | 4 +- .../index.html | 4 +- .../Renderer.K8sApi.NodesStore/index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../Renderer.K8sApi.PodsStore/index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../Renderer.K8sApi.RolesStore/index.html | 4 +- .../Renderer.K8sApi.SecretsStore/index.html | 4 +- .../index.html | 4 +- .../Renderer.K8sApi.ServiceStore/index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../classes/Renderer.LensExtension/index.html | 4 +- .../Renderer.Navigation.PageParam/index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- master/extensions/api/index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../Common.Catalog.TitleCellProps/index.html | 4 +- .../Common.Catalog.WebLinkSpec/index.html | 4 +- .../Common.Catalog.WebLinkStatus/index.html | 4 +- .../Common.EventBus.AppEvent/index.html | 4 +- .../index.html | 4 +- .../Common.LensExtensionManifest/index.html | 4 +- .../api/interfaces/Common.Logger/index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../Common.Types.PageComponents/index.html | 4 +- .../Common.Types.PageParams/index.html | 4 +- .../Common.Types.PageRegistration/index.html | 4 +- .../Common.Types.PageTarget/index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../Common.Types.RegisteredPage/index.html | 4 +- .../Common.Types.ShellEnvContext/index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../Common.Util.Disposable/index.html | 4 +- .../Common.Util.Disposer/index.html | 4 +- .../Common.Util.ExtendableDisposer/index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../Main.K8sApi.IKubeApiCluster/index.html | 4 +- .../index.html | 4 +- .../Main.K8sApi.IPodContainer/index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../Main.K8sApi.ISecretRef/index.html | 4 +- .../index.html | 4 +- .../Main.K8sApi.KubeJsonApiData/index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../Main.K8sApi.KubeStatusData/index.html | 4 +- .../Main.K8sApi.OwnerReference/index.html | 4 +- .../index.html | 4 +- .../Renderer.Component.BadgeProps/index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../Renderer.Component.ButtonProps/index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../Renderer.Component.DialogProps/index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../Renderer.Component.DrawerProps/index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../Renderer.Component.IconProps/index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../Renderer.Component.MenuProps/index.html | 4 +- .../Renderer.Component.MenuStyle/index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../Renderer.Component.RadioProps/index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../Renderer.Component.SelectProps/index.html | 4 +- .../index.html | 4 +- .../Renderer.Component.SliderProps/index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../Renderer.Component.SwitchProps/index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../Renderer.Component.TabProps/index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../Renderer.Component.TableProps/index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../Renderer.Component.TabsProps/index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../Renderer.Component.WizardProps/index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../Renderer.K8sApi.MetricData/index.html | 4 +- .../Renderer.K8sApi.MetricResult/index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../Renderer.Navigation.URLParams/index.html | 4 +- .../Renderer.Theme.LensTheme/index.html | 4 +- .../api/modules/Common.Catalog/index.html | 4 +- .../api/modules/Common.EventBus/index.html | 4 +- .../api/modules/Common.Proxy/index.html | 4 +- .../api/modules/Common.Store/index.html | 4 +- .../api/modules/Common.Types/index.html | 4 +- .../api/modules/Common.Util/index.html | 4 +- .../extensions/api/modules/Common/index.html | 4 +- .../api/modules/Main.Catalog/index.html | 4 +- .../api/modules/Main.K8sApi/index.html | 4 +- .../api/modules/Main.Navigation/index.html | 4 +- .../api/modules/Main.Power/index.html | 4 +- master/extensions/api/modules/Main/index.html | 4 +- .../api/modules/Renderer.Catalog/index.html | 4 +- .../api/modules/Renderer.Component/index.html | 40 +++++++++--------- .../api/modules/Renderer.K8sApi/index.html | 4 +- .../modules/Renderer.Navigation/index.html | 4 +- .../api/modules/Renderer.Theme/index.html | 4 +- .../api/modules/Renderer/index.html | 4 +- master/extensions/api/modules/index.html | 4 +- .../common-capabilities/index.html | 4 +- master/extensions/capabilities/index.html | 4 +- .../capabilities/styling/index.html | 4 +- .../extensions/extension-migration/index.html | 4 +- .../extensions/get-started/anatomy/index.html | 4 +- .../get-started/overview/index.html | 4 +- .../get-started/wrapping-up/index.html | 4 +- .../your-first-extension/index.html | 4 +- master/extensions/guides/anatomy/index.html | 4 +- master/extensions/guides/catalog/index.html | 4 +- .../extensions/guides/components/index.html | 4 +- .../extending-kubernetes-cluster/index.html | 4 +- master/extensions/guides/generator/index.html | 4 +- master/extensions/guides/index.html | 4 +- master/extensions/guides/ipc/index.html | 4 +- .../guides/kube-object-list-layout/index.html | 4 +- .../guides/main-extension/index.html | 4 +- .../guides/protocol-handlers/index.html | 4 +- .../guides/renderer-extension/index.html | 4 +- .../guides/resource-stack/index.html | 4 +- master/extensions/guides/stores/index.html | 4 +- .../guides/working-with-mobx/index.html | 4 +- .../bundling/index.html | 4 +- .../publishing/index.html | 4 +- .../testing-and-publishing/testing/index.html | 4 +- master/extensions/usage/index.html | 4 +- master/index.html | 4 +- master/search/search_index.json | 2 +- master/sitemap.xml.gz | Bin 2462 -> 2462 bytes 309 files changed, 636 insertions(+), 636 deletions(-) rename master/assets/javascripts/{bundle.fac441b0.min.js => bundle.c2be25ad.min.js} (77%) rename master/assets/javascripts/{bundle.fac441b0.min.js.map => bundle.c2be25ad.min.js.map} (95%) diff --git a/master/404.html b/master/404.html index c7d12d5232..4c342a9d4b 100644 --- a/master/404.html +++ b/master/404.html @@ -15,7 +15,7 @@ - + @@ -782,7 +782,7 @@ - + diff --git a/master/architecture/decisions/index.html b/master/architecture/decisions/index.html index 242e7f02b8..75815ba076 100644 --- a/master/architecture/decisions/index.html +++ b/master/architecture/decisions/index.html @@ -17,7 +17,7 @@ - + @@ -801,7 +801,7 @@ - + diff --git a/master/assets/javascripts/bundle.fac441b0.min.js b/master/assets/javascripts/bundle.c2be25ad.min.js similarity index 77% rename from master/assets/javascripts/bundle.fac441b0.min.js rename to master/assets/javascripts/bundle.c2be25ad.min.js index 4bb4cd67de..f32333ee14 100644 --- a/master/assets/javascripts/bundle.fac441b0.min.js +++ b/master/assets/javascripts/bundle.c2be25ad.min.js @@ -1,9 +1,9 @@ -"use strict";(()=>{var Ci=Object.create;var gr=Object.defineProperty;var Ri=Object.getOwnPropertyDescriptor;var ki=Object.getOwnPropertyNames,Ht=Object.getOwnPropertySymbols,Hi=Object.getPrototypeOf,yr=Object.prototype.hasOwnProperty,nn=Object.prototype.propertyIsEnumerable;var rn=(e,t,r)=>t in e?gr(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r,P=(e,t)=>{for(var r in t||(t={}))yr.call(t,r)&&rn(e,r,t[r]);if(Ht)for(var r of Ht(t))nn.call(t,r)&&rn(e,r,t[r]);return e};var on=(e,t)=>{var r={};for(var n in e)yr.call(e,n)&&t.indexOf(n)<0&&(r[n]=e[n]);if(e!=null&&Ht)for(var n of Ht(e))t.indexOf(n)<0&&nn.call(e,n)&&(r[n]=e[n]);return r};var Pt=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports);var Pi=(e,t,r,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of ki(t))!yr.call(e,o)&&o!==r&&gr(e,o,{get:()=>t[o],enumerable:!(n=Ri(t,o))||n.enumerable});return e};var yt=(e,t,r)=>(r=e!=null?Ci(Hi(e)):{},Pi(t||!e||!e.__esModule?gr(r,"default",{value:e,enumerable:!0}):r,e));var sn=Pt((xr,an)=>{(function(e,t){typeof xr=="object"&&typeof an!="undefined"?t():typeof define=="function"&&define.amd?define(t):t()})(xr,function(){"use strict";function e(r){var n=!0,o=!1,i=null,s={text:!0,search:!0,url:!0,tel:!0,email:!0,password:!0,number:!0,date:!0,month:!0,week:!0,time:!0,datetime:!0,"datetime-local":!0};function a(O){return!!(O&&O!==document&&O.nodeName!=="HTML"&&O.nodeName!=="BODY"&&"classList"in O&&"contains"in O.classList)}function f(O){var Qe=O.type,De=O.tagName;return!!(De==="INPUT"&&s[Qe]&&!O.readOnly||De==="TEXTAREA"&&!O.readOnly||O.isContentEditable)}function c(O){O.classList.contains("focus-visible")||(O.classList.add("focus-visible"),O.setAttribute("data-focus-visible-added",""))}function u(O){O.hasAttribute("data-focus-visible-added")&&(O.classList.remove("focus-visible"),O.removeAttribute("data-focus-visible-added"))}function p(O){O.metaKey||O.altKey||O.ctrlKey||(a(r.activeElement)&&c(r.activeElement),n=!0)}function m(O){n=!1}function d(O){a(O.target)&&(n||f(O.target))&&c(O.target)}function h(O){a(O.target)&&(O.target.classList.contains("focus-visible")||O.target.hasAttribute("data-focus-visible-added"))&&(o=!0,window.clearTimeout(i),i=window.setTimeout(function(){o=!1},100),u(O.target))}function v(O){document.visibilityState==="hidden"&&(o&&(n=!0),Q())}function Q(){document.addEventListener("mousemove",N),document.addEventListener("mousedown",N),document.addEventListener("mouseup",N),document.addEventListener("pointermove",N),document.addEventListener("pointerdown",N),document.addEventListener("pointerup",N),document.addEventListener("touchmove",N),document.addEventListener("touchstart",N),document.addEventListener("touchend",N)}function B(){document.removeEventListener("mousemove",N),document.removeEventListener("mousedown",N),document.removeEventListener("mouseup",N),document.removeEventListener("pointermove",N),document.removeEventListener("pointerdown",N),document.removeEventListener("pointerup",N),document.removeEventListener("touchmove",N),document.removeEventListener("touchstart",N),document.removeEventListener("touchend",N)}function N(O){O.target.nodeName&&O.target.nodeName.toLowerCase()==="html"||(n=!1,B())}document.addEventListener("keydown",p,!0),document.addEventListener("mousedown",m,!0),document.addEventListener("pointerdown",m,!0),document.addEventListener("touchstart",m,!0),document.addEventListener("visibilitychange",v,!0),Q(),r.addEventListener("focus",d,!0),r.addEventListener("blur",h,!0),r.nodeType===Node.DOCUMENT_FRAGMENT_NODE&&r.host?r.host.setAttribute("data-js-focus-visible",""):r.nodeType===Node.DOCUMENT_NODE&&(document.documentElement.classList.add("js-focus-visible"),document.documentElement.setAttribute("data-js-focus-visible",""))}if(typeof window!="undefined"&&typeof document!="undefined"){window.applyFocusVisiblePolyfill=e;var t;try{t=new CustomEvent("focus-visible-polyfill-ready")}catch(r){t=document.createEvent("CustomEvent"),t.initCustomEvent("focus-visible-polyfill-ready",!1,!1,{})}window.dispatchEvent(t)}typeof document!="undefined"&&e(document)})});var cn=Pt(Er=>{(function(e){var t=function(){try{return!!Symbol.iterator}catch(c){return!1}},r=t(),n=function(c){var u={next:function(){var p=c.shift();return{done:p===void 0,value:p}}};return r&&(u[Symbol.iterator]=function(){return u}),u},o=function(c){return encodeURIComponent(c).replace(/%20/g,"+")},i=function(c){return decodeURIComponent(String(c).replace(/\+/g," "))},s=function(){var c=function(p){Object.defineProperty(this,"_entries",{writable:!0,value:{}});var m=typeof p;if(m!=="undefined")if(m==="string")p!==""&&this._fromString(p);else if(p instanceof c){var d=this;p.forEach(function(B,N){d.append(N,B)})}else if(p!==null&&m==="object")if(Object.prototype.toString.call(p)==="[object Array]")for(var h=0;hd[0]?1:0}),c._entries&&(c._entries={});for(var p=0;p1?i(d[1]):"")}})})(typeof global!="undefined"?global:typeof window!="undefined"?window:typeof self!="undefined"?self:Er);(function(e){var t=function(){try{var o=new e.URL("b","http://a");return o.pathname="c d",o.href==="http://a/c%20d"&&o.searchParams}catch(i){return!1}},r=function(){var o=e.URL,i=function(f,c){typeof f!="string"&&(f=String(f)),c&&typeof c!="string"&&(c=String(c));var u=document,p;if(c&&(e.location===void 0||c!==e.location.href)){c=c.toLowerCase(),u=document.implementation.createHTMLDocument(""),p=u.createElement("base"),p.href=c,u.head.appendChild(p);try{if(p.href.indexOf(c)!==0)throw new Error(p.href)}catch(O){throw new Error("URL unable to set base "+c+" due to "+O)}}var m=u.createElement("a");m.href=f,p&&(u.body.appendChild(m),m.href=m.href);var d=u.createElement("input");if(d.type="url",d.value=f,m.protocol===":"||!/:/.test(m.href)||!d.checkValidity()&&!c)throw new TypeError("Invalid URL");Object.defineProperty(this,"_anchorElement",{value:m});var h=new e.URLSearchParams(this.search),v=!0,Q=!0,B=this;["append","delete","set"].forEach(function(O){var Qe=h[O];h[O]=function(){Qe.apply(h,arguments),v&&(Q=!1,B.search=h.toString(),Q=!0)}}),Object.defineProperty(this,"searchParams",{value:h,enumerable:!0});var N=void 0;Object.defineProperty(this,"_updateSearchParams",{enumerable:!1,configurable:!1,writable:!1,value:function(){this.search!==N&&(N=this.search,Q&&(v=!1,this.searchParams._fromString(this.search),v=!0))}})},s=i.prototype,a=function(f){Object.defineProperty(s,f,{get:function(){return this._anchorElement[f]},set:function(c){this._anchorElement[f]=c},enumerable:!0})};["hash","host","hostname","port","protocol"].forEach(function(f){a(f)}),Object.defineProperty(s,"search",{get:function(){return this._anchorElement.search},set:function(f){this._anchorElement.search=f,this._updateSearchParams()},enumerable:!0}),Object.defineProperties(s,{toString:{get:function(){var f=this;return function(){return f.href}}},href:{get:function(){return this._anchorElement.href.replace(/\?$/,"")},set:function(f){this._anchorElement.href=f,this._updateSearchParams()},enumerable:!0},pathname:{get:function(){return this._anchorElement.pathname.replace(/(^\/?)/,"/")},set:function(f){this._anchorElement.pathname=f},enumerable:!0},origin:{get:function(){var f={"http:":80,"https:":443,"ftp:":21}[this._anchorElement.protocol],c=this._anchorElement.port!=f&&this._anchorElement.port!=="";return this._anchorElement.protocol+"//"+this._anchorElement.hostname+(c?":"+this._anchorElement.port:"")},enumerable:!0},password:{get:function(){return""},set:function(f){},enumerable:!0},username:{get:function(){return""},set:function(f){},enumerable:!0}}),i.createObjectURL=function(f){return o.createObjectURL.apply(o,arguments)},i.revokeObjectURL=function(f){return o.revokeObjectURL.apply(o,arguments)},e.URL=i};if(t()||r(),e.location!==void 0&&!("origin"in e.location)){var n=function(){return e.location.protocol+"//"+e.location.hostname+(e.location.port?":"+e.location.port:"")};try{Object.defineProperty(e.location,"origin",{get:n,enumerable:!0})}catch(o){setInterval(function(){e.location.origin=n()},100)}}})(typeof global!="undefined"?global:typeof window!="undefined"?window:typeof self!="undefined"?self:Er)});var qr=Pt((Mt,Nr)=>{/*! +"use strict";(()=>{var Ci=Object.create;var gr=Object.defineProperty;var Ri=Object.getOwnPropertyDescriptor;var ki=Object.getOwnPropertyNames,Ht=Object.getOwnPropertySymbols,Hi=Object.getPrototypeOf,yr=Object.prototype.hasOwnProperty,nn=Object.prototype.propertyIsEnumerable;var rn=(e,t,r)=>t in e?gr(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r,P=(e,t)=>{for(var r in t||(t={}))yr.call(t,r)&&rn(e,r,t[r]);if(Ht)for(var r of Ht(t))nn.call(t,r)&&rn(e,r,t[r]);return e};var on=(e,t)=>{var r={};for(var n in e)yr.call(e,n)&&t.indexOf(n)<0&&(r[n]=e[n]);if(e!=null&&Ht)for(var n of Ht(e))t.indexOf(n)<0&&nn.call(e,n)&&(r[n]=e[n]);return r};var Pt=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports);var Pi=(e,t,r,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of ki(t))!yr.call(e,o)&&o!==r&&gr(e,o,{get:()=>t[o],enumerable:!(n=Ri(t,o))||n.enumerable});return e};var yt=(e,t,r)=>(r=e!=null?Ci(Hi(e)):{},Pi(t||!e||!e.__esModule?gr(r,"default",{value:e,enumerable:!0}):r,e));var sn=Pt((xr,an)=>{(function(e,t){typeof xr=="object"&&typeof an!="undefined"?t():typeof define=="function"&&define.amd?define(t):t()})(xr,function(){"use strict";function e(r){var n=!0,o=!1,i=null,s={text:!0,search:!0,url:!0,tel:!0,email:!0,password:!0,number:!0,date:!0,month:!0,week:!0,time:!0,datetime:!0,"datetime-local":!0};function a(O){return!!(O&&O!==document&&O.nodeName!=="HTML"&&O.nodeName!=="BODY"&&"classList"in O&&"contains"in O.classList)}function f(O){var Qe=O.type,De=O.tagName;return!!(De==="INPUT"&&s[Qe]&&!O.readOnly||De==="TEXTAREA"&&!O.readOnly||O.isContentEditable)}function c(O){O.classList.contains("focus-visible")||(O.classList.add("focus-visible"),O.setAttribute("data-focus-visible-added",""))}function u(O){O.hasAttribute("data-focus-visible-added")&&(O.classList.remove("focus-visible"),O.removeAttribute("data-focus-visible-added"))}function p(O){O.metaKey||O.altKey||O.ctrlKey||(a(r.activeElement)&&c(r.activeElement),n=!0)}function m(O){n=!1}function d(O){a(O.target)&&(n||f(O.target))&&c(O.target)}function h(O){a(O.target)&&(O.target.classList.contains("focus-visible")||O.target.hasAttribute("data-focus-visible-added"))&&(o=!0,window.clearTimeout(i),i=window.setTimeout(function(){o=!1},100),u(O.target))}function v(O){document.visibilityState==="hidden"&&(o&&(n=!0),Y())}function Y(){document.addEventListener("mousemove",N),document.addEventListener("mousedown",N),document.addEventListener("mouseup",N),document.addEventListener("pointermove",N),document.addEventListener("pointerdown",N),document.addEventListener("pointerup",N),document.addEventListener("touchmove",N),document.addEventListener("touchstart",N),document.addEventListener("touchend",N)}function B(){document.removeEventListener("mousemove",N),document.removeEventListener("mousedown",N),document.removeEventListener("mouseup",N),document.removeEventListener("pointermove",N),document.removeEventListener("pointerdown",N),document.removeEventListener("pointerup",N),document.removeEventListener("touchmove",N),document.removeEventListener("touchstart",N),document.removeEventListener("touchend",N)}function N(O){O.target.nodeName&&O.target.nodeName.toLowerCase()==="html"||(n=!1,B())}document.addEventListener("keydown",p,!0),document.addEventListener("mousedown",m,!0),document.addEventListener("pointerdown",m,!0),document.addEventListener("touchstart",m,!0),document.addEventListener("visibilitychange",v,!0),Y(),r.addEventListener("focus",d,!0),r.addEventListener("blur",h,!0),r.nodeType===Node.DOCUMENT_FRAGMENT_NODE&&r.host?r.host.setAttribute("data-js-focus-visible",""):r.nodeType===Node.DOCUMENT_NODE&&(document.documentElement.classList.add("js-focus-visible"),document.documentElement.setAttribute("data-js-focus-visible",""))}if(typeof window!="undefined"&&typeof document!="undefined"){window.applyFocusVisiblePolyfill=e;var t;try{t=new CustomEvent("focus-visible-polyfill-ready")}catch(r){t=document.createEvent("CustomEvent"),t.initCustomEvent("focus-visible-polyfill-ready",!1,!1,{})}window.dispatchEvent(t)}typeof document!="undefined"&&e(document)})});var cn=Pt(Er=>{(function(e){var t=function(){try{return!!Symbol.iterator}catch(c){return!1}},r=t(),n=function(c){var u={next:function(){var p=c.shift();return{done:p===void 0,value:p}}};return r&&(u[Symbol.iterator]=function(){return u}),u},o=function(c){return encodeURIComponent(c).replace(/%20/g,"+")},i=function(c){return decodeURIComponent(String(c).replace(/\+/g," "))},s=function(){var c=function(p){Object.defineProperty(this,"_entries",{writable:!0,value:{}});var m=typeof p;if(m!=="undefined")if(m==="string")p!==""&&this._fromString(p);else if(p instanceof c){var d=this;p.forEach(function(B,N){d.append(N,B)})}else if(p!==null&&m==="object")if(Object.prototype.toString.call(p)==="[object Array]")for(var h=0;hd[0]?1:0}),c._entries&&(c._entries={});for(var p=0;p1?i(d[1]):"")}})})(typeof global!="undefined"?global:typeof window!="undefined"?window:typeof self!="undefined"?self:Er);(function(e){var t=function(){try{var o=new e.URL("b","http://a");return o.pathname="c d",o.href==="http://a/c%20d"&&o.searchParams}catch(i){return!1}},r=function(){var o=e.URL,i=function(f,c){typeof f!="string"&&(f=String(f)),c&&typeof c!="string"&&(c=String(c));var u=document,p;if(c&&(e.location===void 0||c!==e.location.href)){c=c.toLowerCase(),u=document.implementation.createHTMLDocument(""),p=u.createElement("base"),p.href=c,u.head.appendChild(p);try{if(p.href.indexOf(c)!==0)throw new Error(p.href)}catch(O){throw new Error("URL unable to set base "+c+" due to "+O)}}var m=u.createElement("a");m.href=f,p&&(u.body.appendChild(m),m.href=m.href);var d=u.createElement("input");if(d.type="url",d.value=f,m.protocol===":"||!/:/.test(m.href)||!d.checkValidity()&&!c)throw new TypeError("Invalid URL");Object.defineProperty(this,"_anchorElement",{value:m});var h=new e.URLSearchParams(this.search),v=!0,Y=!0,B=this;["append","delete","set"].forEach(function(O){var Qe=h[O];h[O]=function(){Qe.apply(h,arguments),v&&(Y=!1,B.search=h.toString(),Y=!0)}}),Object.defineProperty(this,"searchParams",{value:h,enumerable:!0});var N=void 0;Object.defineProperty(this,"_updateSearchParams",{enumerable:!1,configurable:!1,writable:!1,value:function(){this.search!==N&&(N=this.search,Y&&(v=!1,this.searchParams._fromString(this.search),v=!0))}})},s=i.prototype,a=function(f){Object.defineProperty(s,f,{get:function(){return this._anchorElement[f]},set:function(c){this._anchorElement[f]=c},enumerable:!0})};["hash","host","hostname","port","protocol"].forEach(function(f){a(f)}),Object.defineProperty(s,"search",{get:function(){return this._anchorElement.search},set:function(f){this._anchorElement.search=f,this._updateSearchParams()},enumerable:!0}),Object.defineProperties(s,{toString:{get:function(){var f=this;return function(){return f.href}}},href:{get:function(){return this._anchorElement.href.replace(/\?$/,"")},set:function(f){this._anchorElement.href=f,this._updateSearchParams()},enumerable:!0},pathname:{get:function(){return this._anchorElement.pathname.replace(/(^\/?)/,"/")},set:function(f){this._anchorElement.pathname=f},enumerable:!0},origin:{get:function(){var f={"http:":80,"https:":443,"ftp:":21}[this._anchorElement.protocol],c=this._anchorElement.port!=f&&this._anchorElement.port!=="";return this._anchorElement.protocol+"//"+this._anchorElement.hostname+(c?":"+this._anchorElement.port:"")},enumerable:!0},password:{get:function(){return""},set:function(f){},enumerable:!0},username:{get:function(){return""},set:function(f){},enumerable:!0}}),i.createObjectURL=function(f){return o.createObjectURL.apply(o,arguments)},i.revokeObjectURL=function(f){return o.revokeObjectURL.apply(o,arguments)},e.URL=i};if(t()||r(),e.location!==void 0&&!("origin"in e.location)){var n=function(){return e.location.protocol+"//"+e.location.hostname+(e.location.port?":"+e.location.port:"")};try{Object.defineProperty(e.location,"origin",{get:n,enumerable:!0})}catch(o){setInterval(function(){e.location.origin=n()},100)}}})(typeof global!="undefined"?global:typeof window!="undefined"?window:typeof self!="undefined"?self:Er)});var qr=Pt((Mt,Nr)=>{/*! * clipboard.js v2.0.11 * https://clipboardjs.com/ * * Licensed MIT © Zeno Rocha - */(function(t,r){typeof Mt=="object"&&typeof Nr=="object"?Nr.exports=r():typeof define=="function"&&define.amd?define([],r):typeof Mt=="object"?Mt.ClipboardJS=r():t.ClipboardJS=r()})(Mt,function(){return function(){var e={686:function(n,o,i){"use strict";i.d(o,{default:function(){return Ai}});var s=i(279),a=i.n(s),f=i(370),c=i.n(f),u=i(817),p=i.n(u);function m(j){try{return document.execCommand(j)}catch(T){return!1}}var d=function(T){var E=p()(T);return m("cut"),E},h=d;function v(j){var T=document.documentElement.getAttribute("dir")==="rtl",E=document.createElement("textarea");E.style.fontSize="12pt",E.style.border="0",E.style.padding="0",E.style.margin="0",E.style.position="absolute",E.style[T?"right":"left"]="-9999px";var H=window.pageYOffset||document.documentElement.scrollTop;return E.style.top="".concat(H,"px"),E.setAttribute("readonly",""),E.value=j,E}var Q=function(T,E){var H=v(T);E.container.appendChild(H);var I=p()(H);return m("copy"),H.remove(),I},B=function(T){var E=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body},H="";return typeof T=="string"?H=Q(T,E):T instanceof HTMLInputElement&&!["text","search","url","tel","password"].includes(T==null?void 0:T.type)?H=Q(T.value,E):(H=p()(T),m("copy")),H},N=B;function O(j){return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?O=function(E){return typeof E}:O=function(E){return E&&typeof Symbol=="function"&&E.constructor===Symbol&&E!==Symbol.prototype?"symbol":typeof E},O(j)}var Qe=function(){var T=arguments.length>0&&arguments[0]!==void 0?arguments[0]:{},E=T.action,H=E===void 0?"copy":E,I=T.container,q=T.target,Me=T.text;if(H!=="copy"&&H!=="cut")throw new Error('Invalid "action" value, use either "copy" or "cut"');if(q!==void 0)if(q&&O(q)==="object"&&q.nodeType===1){if(H==="copy"&&q.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if(H==="cut"&&(q.hasAttribute("readonly")||q.hasAttribute("disabled")))throw new Error(`Invalid "target" attribute. You can't cut text from elements with "readonly" or "disabled" attributes`)}else throw new Error('Invalid "target" value, use a valid Element');if(Me)return N(Me,{container:I});if(q)return H==="cut"?h(q):N(q,{container:I})},De=Qe;function $e(j){return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?$e=function(E){return typeof E}:$e=function(E){return E&&typeof Symbol=="function"&&E.constructor===Symbol&&E!==Symbol.prototype?"symbol":typeof E},$e(j)}function Ei(j,T){if(!(j instanceof T))throw new TypeError("Cannot call a class as a function")}function tn(j,T){for(var E=0;E0&&arguments[0]!==void 0?arguments[0]:{};this.action=typeof I.action=="function"?I.action:this.defaultAction,this.target=typeof I.target=="function"?I.target:this.defaultTarget,this.text=typeof I.text=="function"?I.text:this.defaultText,this.container=$e(I.container)==="object"?I.container:document.body}},{key:"listenClick",value:function(I){var q=this;this.listener=c()(I,"click",function(Me){return q.onClick(Me)})}},{key:"onClick",value:function(I){var q=I.delegateTarget||I.currentTarget,Me=this.action(q)||"copy",kt=De({action:Me,container:this.container,target:this.target(q),text:this.text(q)});this.emit(kt?"success":"error",{action:Me,text:kt,trigger:q,clearSelection:function(){q&&q.focus(),window.getSelection().removeAllRanges()}})}},{key:"defaultAction",value:function(I){return vr("action",I)}},{key:"defaultTarget",value:function(I){var q=vr("target",I);if(q)return document.querySelector(q)}},{key:"defaultText",value:function(I){return vr("text",I)}},{key:"destroy",value:function(){this.listener.destroy()}}],[{key:"copy",value:function(I){var q=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body};return N(I,q)}},{key:"cut",value:function(I){return h(I)}},{key:"isSupported",value:function(){var I=arguments.length>0&&arguments[0]!==void 0?arguments[0]:["copy","cut"],q=typeof I=="string"?[I]:I,Me=!!document.queryCommandSupported;return q.forEach(function(kt){Me=Me&&!!document.queryCommandSupported(kt)}),Me}}]),E}(a()),Ai=Li},828:function(n){var o=9;if(typeof Element!="undefined"&&!Element.prototype.matches){var i=Element.prototype;i.matches=i.matchesSelector||i.mozMatchesSelector||i.msMatchesSelector||i.oMatchesSelector||i.webkitMatchesSelector}function s(a,f){for(;a&&a.nodeType!==o;){if(typeof a.matches=="function"&&a.matches(f))return a;a=a.parentNode}}n.exports=s},438:function(n,o,i){var s=i(828);function a(u,p,m,d,h){var v=c.apply(this,arguments);return u.addEventListener(m,v,h),{destroy:function(){u.removeEventListener(m,v,h)}}}function f(u,p,m,d,h){return typeof u.addEventListener=="function"?a.apply(null,arguments):typeof m=="function"?a.bind(null,document).apply(null,arguments):(typeof u=="string"&&(u=document.querySelectorAll(u)),Array.prototype.map.call(u,function(v){return a(v,p,m,d,h)}))}function c(u,p,m,d){return function(h){h.delegateTarget=s(h.target,p),h.delegateTarget&&d.call(u,h)}}n.exports=f},879:function(n,o){o.node=function(i){return i!==void 0&&i instanceof HTMLElement&&i.nodeType===1},o.nodeList=function(i){var s=Object.prototype.toString.call(i);return i!==void 0&&(s==="[object NodeList]"||s==="[object HTMLCollection]")&&"length"in i&&(i.length===0||o.node(i[0]))},o.string=function(i){return typeof i=="string"||i instanceof String},o.fn=function(i){var s=Object.prototype.toString.call(i);return s==="[object Function]"}},370:function(n,o,i){var s=i(879),a=i(438);function f(m,d,h){if(!m&&!d&&!h)throw new Error("Missing required arguments");if(!s.string(d))throw new TypeError("Second argument must be a String");if(!s.fn(h))throw new TypeError("Third argument must be a Function");if(s.node(m))return c(m,d,h);if(s.nodeList(m))return u(m,d,h);if(s.string(m))return p(m,d,h);throw new TypeError("First argument must be a String, HTMLElement, HTMLCollection, or NodeList")}function c(m,d,h){return m.addEventListener(d,h),{destroy:function(){m.removeEventListener(d,h)}}}function u(m,d,h){return Array.prototype.forEach.call(m,function(v){v.addEventListener(d,h)}),{destroy:function(){Array.prototype.forEach.call(m,function(v){v.removeEventListener(d,h)})}}}function p(m,d,h){return a(document.body,m,d,h)}n.exports=f},817:function(n){function o(i){var s;if(i.nodeName==="SELECT")i.focus(),s=i.value;else if(i.nodeName==="INPUT"||i.nodeName==="TEXTAREA"){var a=i.hasAttribute("readonly");a||i.setAttribute("readonly",""),i.select(),i.setSelectionRange(0,i.value.length),a||i.removeAttribute("readonly"),s=i.value}else{i.hasAttribute("contenteditable")&&i.focus();var f=window.getSelection(),c=document.createRange();c.selectNodeContents(i),f.removeAllRanges(),f.addRange(c),s=f.toString()}return s}n.exports=o},279:function(n){function o(){}o.prototype={on:function(i,s,a){var f=this.e||(this.e={});return(f[i]||(f[i]=[])).push({fn:s,ctx:a}),this},once:function(i,s,a){var f=this;function c(){f.off(i,c),s.apply(a,arguments)}return c._=s,this.on(i,c,a)},emit:function(i){var s=[].slice.call(arguments,1),a=((this.e||(this.e={}))[i]||[]).slice(),f=0,c=a.length;for(f;f{"use strict";/*! + */(function(t,r){typeof Mt=="object"&&typeof Nr=="object"?Nr.exports=r():typeof define=="function"&&define.amd?define([],r):typeof Mt=="object"?Mt.ClipboardJS=r():t.ClipboardJS=r()})(Mt,function(){return function(){var e={686:function(n,o,i){"use strict";i.d(o,{default:function(){return Ai}});var s=i(279),a=i.n(s),f=i(370),c=i.n(f),u=i(817),p=i.n(u);function m(j){try{return document.execCommand(j)}catch(T){return!1}}var d=function(T){var E=p()(T);return m("cut"),E},h=d;function v(j){var T=document.documentElement.getAttribute("dir")==="rtl",E=document.createElement("textarea");E.style.fontSize="12pt",E.style.border="0",E.style.padding="0",E.style.margin="0",E.style.position="absolute",E.style[T?"right":"left"]="-9999px";var H=window.pageYOffset||document.documentElement.scrollTop;return E.style.top="".concat(H,"px"),E.setAttribute("readonly",""),E.value=j,E}var Y=function(T,E){var H=v(T);E.container.appendChild(H);var I=p()(H);return m("copy"),H.remove(),I},B=function(T){var E=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body},H="";return typeof T=="string"?H=Y(T,E):T instanceof HTMLInputElement&&!["text","search","url","tel","password"].includes(T==null?void 0:T.type)?H=Y(T.value,E):(H=p()(T),m("copy")),H},N=B;function O(j){return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?O=function(E){return typeof E}:O=function(E){return E&&typeof Symbol=="function"&&E.constructor===Symbol&&E!==Symbol.prototype?"symbol":typeof E},O(j)}var Qe=function(){var T=arguments.length>0&&arguments[0]!==void 0?arguments[0]:{},E=T.action,H=E===void 0?"copy":E,I=T.container,q=T.target,Me=T.text;if(H!=="copy"&&H!=="cut")throw new Error('Invalid "action" value, use either "copy" or "cut"');if(q!==void 0)if(q&&O(q)==="object"&&q.nodeType===1){if(H==="copy"&&q.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if(H==="cut"&&(q.hasAttribute("readonly")||q.hasAttribute("disabled")))throw new Error(`Invalid "target" attribute. You can't cut text from elements with "readonly" or "disabled" attributes`)}else throw new Error('Invalid "target" value, use a valid Element');if(Me)return N(Me,{container:I});if(q)return H==="cut"?h(q):N(q,{container:I})},De=Qe;function $e(j){return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?$e=function(E){return typeof E}:$e=function(E){return E&&typeof Symbol=="function"&&E.constructor===Symbol&&E!==Symbol.prototype?"symbol":typeof E},$e(j)}function Ei(j,T){if(!(j instanceof T))throw new TypeError("Cannot call a class as a function")}function tn(j,T){for(var E=0;E0&&arguments[0]!==void 0?arguments[0]:{};this.action=typeof I.action=="function"?I.action:this.defaultAction,this.target=typeof I.target=="function"?I.target:this.defaultTarget,this.text=typeof I.text=="function"?I.text:this.defaultText,this.container=$e(I.container)==="object"?I.container:document.body}},{key:"listenClick",value:function(I){var q=this;this.listener=c()(I,"click",function(Me){return q.onClick(Me)})}},{key:"onClick",value:function(I){var q=I.delegateTarget||I.currentTarget,Me=this.action(q)||"copy",kt=De({action:Me,container:this.container,target:this.target(q),text:this.text(q)});this.emit(kt?"success":"error",{action:Me,text:kt,trigger:q,clearSelection:function(){q&&q.focus(),window.getSelection().removeAllRanges()}})}},{key:"defaultAction",value:function(I){return vr("action",I)}},{key:"defaultTarget",value:function(I){var q=vr("target",I);if(q)return document.querySelector(q)}},{key:"defaultText",value:function(I){return vr("text",I)}},{key:"destroy",value:function(){this.listener.destroy()}}],[{key:"copy",value:function(I){var q=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body};return N(I,q)}},{key:"cut",value:function(I){return h(I)}},{key:"isSupported",value:function(){var I=arguments.length>0&&arguments[0]!==void 0?arguments[0]:["copy","cut"],q=typeof I=="string"?[I]:I,Me=!!document.queryCommandSupported;return q.forEach(function(kt){Me=Me&&!!document.queryCommandSupported(kt)}),Me}}]),E}(a()),Ai=Li},828:function(n){var o=9;if(typeof Element!="undefined"&&!Element.prototype.matches){var i=Element.prototype;i.matches=i.matchesSelector||i.mozMatchesSelector||i.msMatchesSelector||i.oMatchesSelector||i.webkitMatchesSelector}function s(a,f){for(;a&&a.nodeType!==o;){if(typeof a.matches=="function"&&a.matches(f))return a;a=a.parentNode}}n.exports=s},438:function(n,o,i){var s=i(828);function a(u,p,m,d,h){var v=c.apply(this,arguments);return u.addEventListener(m,v,h),{destroy:function(){u.removeEventListener(m,v,h)}}}function f(u,p,m,d,h){return typeof u.addEventListener=="function"?a.apply(null,arguments):typeof m=="function"?a.bind(null,document).apply(null,arguments):(typeof u=="string"&&(u=document.querySelectorAll(u)),Array.prototype.map.call(u,function(v){return a(v,p,m,d,h)}))}function c(u,p,m,d){return function(h){h.delegateTarget=s(h.target,p),h.delegateTarget&&d.call(u,h)}}n.exports=f},879:function(n,o){o.node=function(i){return i!==void 0&&i instanceof HTMLElement&&i.nodeType===1},o.nodeList=function(i){var s=Object.prototype.toString.call(i);return i!==void 0&&(s==="[object NodeList]"||s==="[object HTMLCollection]")&&"length"in i&&(i.length===0||o.node(i[0]))},o.string=function(i){return typeof i=="string"||i instanceof String},o.fn=function(i){var s=Object.prototype.toString.call(i);return s==="[object Function]"}},370:function(n,o,i){var s=i(879),a=i(438);function f(m,d,h){if(!m&&!d&&!h)throw new Error("Missing required arguments");if(!s.string(d))throw new TypeError("Second argument must be a String");if(!s.fn(h))throw new TypeError("Third argument must be a Function");if(s.node(m))return c(m,d,h);if(s.nodeList(m))return u(m,d,h);if(s.string(m))return p(m,d,h);throw new TypeError("First argument must be a String, HTMLElement, HTMLCollection, or NodeList")}function c(m,d,h){return m.addEventListener(d,h),{destroy:function(){m.removeEventListener(d,h)}}}function u(m,d,h){return Array.prototype.forEach.call(m,function(v){v.addEventListener(d,h)}),{destroy:function(){Array.prototype.forEach.call(m,function(v){v.removeEventListener(d,h)})}}}function p(m,d,h){return a(document.body,m,d,h)}n.exports=f},817:function(n){function o(i){var s;if(i.nodeName==="SELECT")i.focus(),s=i.value;else if(i.nodeName==="INPUT"||i.nodeName==="TEXTAREA"){var a=i.hasAttribute("readonly");a||i.setAttribute("readonly",""),i.select(),i.setSelectionRange(0,i.value.length),a||i.removeAttribute("readonly"),s=i.value}else{i.hasAttribute("contenteditable")&&i.focus();var f=window.getSelection(),c=document.createRange();c.selectNodeContents(i),f.removeAllRanges(),f.addRange(c),s=f.toString()}return s}n.exports=o},279:function(n){function o(){}o.prototype={on:function(i,s,a){var f=this.e||(this.e={});return(f[i]||(f[i]=[])).push({fn:s,ctx:a}),this},once:function(i,s,a){var f=this;function c(){f.off(i,c),s.apply(a,arguments)}return c._=s,this.on(i,c,a)},emit:function(i){var s=[].slice.call(arguments,1),a=((this.e||(this.e={}))[i]||[]).slice(),f=0,c=a.length;for(f;f{"use strict";/*! * escape-html * Copyright(c) 2012-2013 TJ Holowaychuk * Copyright(c) 2015 Andreas Lubbe @@ -24,6 +24,6 @@ OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ***************************************************************************** */var wr=function(e,t){return wr=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(r,n){r.__proto__=n}||function(r,n){for(var o in n)Object.prototype.hasOwnProperty.call(n,o)&&(r[o]=n[o])},wr(e,t)};function ie(e,t){if(typeof t!="function"&&t!==null)throw new TypeError("Class extends value "+String(t)+" is not a constructor or null");wr(e,t);function r(){this.constructor=e}e.prototype=t===null?Object.create(t):(r.prototype=t.prototype,new r)}function fn(e,t,r,n){function o(i){return i instanceof r?i:new r(function(s){s(i)})}return new(r||(r=Promise))(function(i,s){function a(u){try{c(n.next(u))}catch(p){s(p)}}function f(u){try{c(n.throw(u))}catch(p){s(p)}}function c(u){u.done?i(u.value):o(u.value).then(a,f)}c((n=n.apply(e,t||[])).next())})}function $t(e,t){var r={label:0,sent:function(){if(i[0]&1)throw i[1];return i[1]},trys:[],ops:[]},n,o,i,s;return s={next:a(0),throw:a(1),return:a(2)},typeof Symbol=="function"&&(s[Symbol.iterator]=function(){return this}),s;function a(c){return function(u){return f([c,u])}}function f(c){if(n)throw new TypeError("Generator is already executing.");for(;r;)try{if(n=1,o&&(i=c[0]&2?o.return:c[0]?o.throw||((i=o.return)&&i.call(o),0):o.next)&&!(i=i.call(o,c[1])).done)return i;switch(o=0,i&&(c=[c[0]&2,i.value]),c[0]){case 0:case 1:i=c;break;case 4:return r.label++,{value:c[1],done:!1};case 5:r.label++,o=c[1],c=[0];continue;case 7:c=r.ops.pop(),r.trys.pop();continue;default:if(i=r.trys,!(i=i.length>0&&i[i.length-1])&&(c[0]===6||c[0]===2)){r=0;continue}if(c[0]===3&&(!i||c[1]>i[0]&&c[1]=e.length&&(e=void 0),{value:e&&e[n++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")}function W(e,t){var r=typeof Symbol=="function"&&e[Symbol.iterator];if(!r)return e;var n=r.call(e),o,i=[],s;try{for(;(t===void 0||t-- >0)&&!(o=n.next()).done;)i.push(o.value)}catch(a){s={error:a}}finally{try{o&&!o.done&&(r=n.return)&&r.call(n)}finally{if(s)throw s.error}}return i}function D(e,t,r){if(r||arguments.length===2)for(var n=0,o=t.length,i;n1||a(m,d)})})}function a(m,d){try{f(n[m](d))}catch(h){p(i[0][3],h)}}function f(m){m.value instanceof et?Promise.resolve(m.value.v).then(c,u):p(i[0][2],m)}function c(m){a("next",m)}function u(m){a("throw",m)}function p(m,d){m(d),i.shift(),i.length&&a(i[0][0],i[0][1])}}function pn(e){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var t=e[Symbol.asyncIterator],r;return t?t.call(e):(e=typeof Ee=="function"?Ee(e):e[Symbol.iterator](),r={},n("next"),n("throw"),n("return"),r[Symbol.asyncIterator]=function(){return this},r);function n(i){r[i]=e[i]&&function(s){return new Promise(function(a,f){s=e[i](s),o(a,f,s.done,s.value)})}}function o(i,s,a,f){Promise.resolve(f).then(function(c){i({value:c,done:a})},s)}}function C(e){return typeof e=="function"}function at(e){var t=function(n){Error.call(n),n.stack=new Error().stack},r=e(t);return r.prototype=Object.create(Error.prototype),r.prototype.constructor=r,r}var It=at(function(e){return function(r){e(this),this.message=r?r.length+` errors occurred during unsubscription: `+r.map(function(n,o){return o+1+") "+n.toString()}).join(` - `):"",this.name="UnsubscriptionError",this.errors=r}});function Ve(e,t){if(e){var r=e.indexOf(t);0<=r&&e.splice(r,1)}}var Ie=function(){function e(t){this.initialTeardown=t,this.closed=!1,this._parentage=null,this._finalizers=null}return e.prototype.unsubscribe=function(){var t,r,n,o,i;if(!this.closed){this.closed=!0;var s=this._parentage;if(s)if(this._parentage=null,Array.isArray(s))try{for(var a=Ee(s),f=a.next();!f.done;f=a.next()){var c=f.value;c.remove(this)}}catch(v){t={error:v}}finally{try{f&&!f.done&&(r=a.return)&&r.call(a)}finally{if(t)throw t.error}}else s.remove(this);var u=this.initialTeardown;if(C(u))try{u()}catch(v){i=v instanceof It?v.errors:[v]}var p=this._finalizers;if(p){this._finalizers=null;try{for(var m=Ee(p),d=m.next();!d.done;d=m.next()){var h=d.value;try{ln(h)}catch(v){i=i!=null?i:[],v instanceof It?i=D(D([],W(i)),W(v.errors)):i.push(v)}}}catch(v){n={error:v}}finally{try{d&&!d.done&&(o=m.return)&&o.call(m)}finally{if(n)throw n.error}}}if(i)throw new It(i)}},e.prototype.add=function(t){var r;if(t&&t!==this)if(this.closed)ln(t);else{if(t instanceof e){if(t.closed||t._hasParent(this))return;t._addParent(this)}(this._finalizers=(r=this._finalizers)!==null&&r!==void 0?r:[]).push(t)}},e.prototype._hasParent=function(t){var r=this._parentage;return r===t||Array.isArray(r)&&r.includes(t)},e.prototype._addParent=function(t){var r=this._parentage;this._parentage=Array.isArray(r)?(r.push(t),r):r?[r,t]:t},e.prototype._removeParent=function(t){var r=this._parentage;r===t?this._parentage=null:Array.isArray(r)&&Ve(r,t)},e.prototype.remove=function(t){var r=this._finalizers;r&&Ve(r,t),t instanceof e&&t._removeParent(this)},e.EMPTY=function(){var t=new e;return t.closed=!0,t}(),e}();var Sr=Ie.EMPTY;function jt(e){return e instanceof Ie||e&&"closed"in e&&C(e.remove)&&C(e.add)&&C(e.unsubscribe)}function ln(e){C(e)?e():e.unsubscribe()}var Le={onUnhandledError:null,onStoppedNotification:null,Promise:void 0,useDeprecatedSynchronousErrorHandling:!1,useDeprecatedNextContext:!1};var st={setTimeout:function(e,t){for(var r=[],n=2;n0},enumerable:!1,configurable:!0}),t.prototype._trySubscribe=function(r){return this._throwIfClosed(),e.prototype._trySubscribe.call(this,r)},t.prototype._subscribe=function(r){return this._throwIfClosed(),this._checkFinalizedStatuses(r),this._innerSubscribe(r)},t.prototype._innerSubscribe=function(r){var n=this,o=this,i=o.hasError,s=o.isStopped,a=o.observers;return i||s?Sr:(this.currentObservers=null,a.push(r),new Ie(function(){n.currentObservers=null,Ve(a,r)}))},t.prototype._checkFinalizedStatuses=function(r){var n=this,o=n.hasError,i=n.thrownError,s=n.isStopped;o?r.error(i):s&&r.complete()},t.prototype.asObservable=function(){var r=new F;return r.source=this,r},t.create=function(r,n){return new xn(r,n)},t}(F);var xn=function(e){ie(t,e);function t(r,n){var o=e.call(this)||this;return o.destination=r,o.source=n,o}return t.prototype.next=function(r){var n,o;(o=(n=this.destination)===null||n===void 0?void 0:n.next)===null||o===void 0||o.call(n,r)},t.prototype.error=function(r){var n,o;(o=(n=this.destination)===null||n===void 0?void 0:n.error)===null||o===void 0||o.call(n,r)},t.prototype.complete=function(){var r,n;(n=(r=this.destination)===null||r===void 0?void 0:r.complete)===null||n===void 0||n.call(r)},t.prototype._subscribe=function(r){var n,o;return(o=(n=this.source)===null||n===void 0?void 0:n.subscribe(r))!==null&&o!==void 0?o:Sr},t}(x);var Et={now:function(){return(Et.delegate||Date).now()},delegate:void 0};var wt=function(e){ie(t,e);function t(r,n,o){r===void 0&&(r=1/0),n===void 0&&(n=1/0),o===void 0&&(o=Et);var i=e.call(this)||this;return i._bufferSize=r,i._windowTime=n,i._timestampProvider=o,i._buffer=[],i._infiniteTimeWindow=!0,i._infiniteTimeWindow=n===1/0,i._bufferSize=Math.max(1,r),i._windowTime=Math.max(1,n),i}return t.prototype.next=function(r){var n=this,o=n.isStopped,i=n._buffer,s=n._infiniteTimeWindow,a=n._timestampProvider,f=n._windowTime;o||(i.push(r),!s&&i.push(a.now()+f)),this._trimBuffer(),e.prototype.next.call(this,r)},t.prototype._subscribe=function(r){this._throwIfClosed(),this._trimBuffer();for(var n=this._innerSubscribe(r),o=this,i=o._infiniteTimeWindow,s=o._buffer,a=s.slice(),f=0;f0?e.prototype.requestAsyncId.call(this,r,n,o):(r.actions.push(this),r._scheduled||(r._scheduled=ut.requestAnimationFrame(function(){return r.flush(void 0)})))},t.prototype.recycleAsyncId=function(r,n,o){var i;if(o===void 0&&(o=0),o!=null?o>0:this.delay>0)return e.prototype.recycleAsyncId.call(this,r,n,o);var s=r.actions;n!=null&&((i=s[s.length-1])===null||i===void 0?void 0:i.id)!==n&&(ut.cancelAnimationFrame(n),r._scheduled=void 0)},t}(Wt);var Sn=function(e){ie(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t.prototype.flush=function(r){this._active=!0;var n=this._scheduled;this._scheduled=void 0;var o=this.actions,i;r=r||o.shift();do if(i=r.execute(r.state,r.delay))break;while((r=o[0])&&r.id===n&&o.shift());if(this._active=!1,i){for(;(r=o[0])&&r.id===n&&o.shift();)r.unsubscribe();throw i}},t}(Dt);var Oe=new Sn(wn);var _=new F(function(e){return e.complete()});function Vt(e){return e&&C(e.schedule)}function Cr(e){return e[e.length-1]}function Ye(e){return C(Cr(e))?e.pop():void 0}function Te(e){return Vt(Cr(e))?e.pop():void 0}function zt(e,t){return typeof Cr(e)=="number"?e.pop():t}var pt=function(e){return e&&typeof e.length=="number"&&typeof e!="function"};function Nt(e){return C(e==null?void 0:e.then)}function qt(e){return C(e[ft])}function Kt(e){return Symbol.asyncIterator&&C(e==null?void 0:e[Symbol.asyncIterator])}function Qt(e){return new TypeError("You provided "+(e!==null&&typeof e=="object"?"an invalid object":"'"+e+"'")+" where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.")}function zi(){return typeof Symbol!="function"||!Symbol.iterator?"@@iterator":Symbol.iterator}var Yt=zi();function Gt(e){return C(e==null?void 0:e[Yt])}function Bt(e){return un(this,arguments,function(){var r,n,o,i;return $t(this,function(s){switch(s.label){case 0:r=e.getReader(),s.label=1;case 1:s.trys.push([1,,9,10]),s.label=2;case 2:return[4,et(r.read())];case 3:return n=s.sent(),o=n.value,i=n.done,i?[4,et(void 0)]:[3,5];case 4:return[2,s.sent()];case 5:return[4,et(o)];case 6:return[4,s.sent()];case 7:return s.sent(),[3,2];case 8:return[3,10];case 9:return r.releaseLock(),[7];case 10:return[2]}})})}function Jt(e){return C(e==null?void 0:e.getReader)}function U(e){if(e instanceof F)return e;if(e!=null){if(qt(e))return Ni(e);if(pt(e))return qi(e);if(Nt(e))return Ki(e);if(Kt(e))return On(e);if(Gt(e))return Qi(e);if(Jt(e))return Yi(e)}throw Qt(e)}function Ni(e){return new F(function(t){var r=e[ft]();if(C(r.subscribe))return r.subscribe(t);throw new TypeError("Provided object does not correctly implement Symbol.observable")})}function qi(e){return new F(function(t){for(var r=0;r=2;return function(n){return n.pipe(e?A(function(o,i){return e(o,i,n)}):de,ge(1),r?He(t):Dn(function(){return new Zt}))}}function Vn(){for(var e=[],t=0;t=2,!0))}function pe(e){e===void 0&&(e={});var t=e.connector,r=t===void 0?function(){return new x}:t,n=e.resetOnError,o=n===void 0?!0:n,i=e.resetOnComplete,s=i===void 0?!0:i,a=e.resetOnRefCountZero,f=a===void 0?!0:a;return function(c){var u,p,m,d=0,h=!1,v=!1,Q=function(){p==null||p.unsubscribe(),p=void 0},B=function(){Q(),u=m=void 0,h=v=!1},N=function(){var O=u;B(),O==null||O.unsubscribe()};return y(function(O,Qe){d++,!v&&!h&&Q();var De=m=m!=null?m:r();Qe.add(function(){d--,d===0&&!v&&!h&&(p=$r(N,f))}),De.subscribe(Qe),!u&&d>0&&(u=new rt({next:function($e){return De.next($e)},error:function($e){v=!0,Q(),p=$r(B,o,$e),De.error($e)},complete:function(){h=!0,Q(),p=$r(B,s),De.complete()}}),U(O).subscribe(u))})(c)}}function $r(e,t){for(var r=[],n=2;ne.next(document)),e}function K(e,t=document){return Array.from(t.querySelectorAll(e))}function z(e,t=document){let r=ce(e,t);if(typeof r=="undefined")throw new ReferenceError(`Missing element: expected "${e}" to be present`);return r}function ce(e,t=document){return t.querySelector(e)||void 0}function _e(){return document.activeElement instanceof HTMLElement&&document.activeElement||void 0}function tr(e){return L(b(document.body,"focusin"),b(document.body,"focusout")).pipe(ke(1),l(()=>{let t=_e();return typeof t!="undefined"?e.contains(t):!1}),V(e===_e()),J())}function Xe(e){return{x:e.offsetLeft,y:e.offsetTop}}function Kn(e){return L(b(window,"load"),b(window,"resize")).pipe(Ce(0,Oe),l(()=>Xe(e)),V(Xe(e)))}function rr(e){return{x:e.scrollLeft,y:e.scrollTop}}function dt(e){return L(b(e,"scroll"),b(window,"resize")).pipe(Ce(0,Oe),l(()=>rr(e)),V(rr(e)))}var Yn=function(){if(typeof Map!="undefined")return Map;function e(t,r){var n=-1;return t.some(function(o,i){return o[0]===r?(n=i,!0):!1}),n}return function(){function t(){this.__entries__=[]}return Object.defineProperty(t.prototype,"size",{get:function(){return this.__entries__.length},enumerable:!0,configurable:!0}),t.prototype.get=function(r){var n=e(this.__entries__,r),o=this.__entries__[n];return o&&o[1]},t.prototype.set=function(r,n){var o=e(this.__entries__,r);~o?this.__entries__[o][1]=n:this.__entries__.push([r,n])},t.prototype.delete=function(r){var n=this.__entries__,o=e(n,r);~o&&n.splice(o,1)},t.prototype.has=function(r){return!!~e(this.__entries__,r)},t.prototype.clear=function(){this.__entries__.splice(0)},t.prototype.forEach=function(r,n){n===void 0&&(n=null);for(var o=0,i=this.__entries__;o0},e.prototype.connect_=function(){!Wr||this.connected_||(document.addEventListener("transitionend",this.onTransitionEnd_),window.addEventListener("resize",this.refresh),va?(this.mutationsObserver_=new MutationObserver(this.refresh),this.mutationsObserver_.observe(document,{attributes:!0,childList:!0,characterData:!0,subtree:!0})):(document.addEventListener("DOMSubtreeModified",this.refresh),this.mutationEventsAdded_=!0),this.connected_=!0)},e.prototype.disconnect_=function(){!Wr||!this.connected_||(document.removeEventListener("transitionend",this.onTransitionEnd_),window.removeEventListener("resize",this.refresh),this.mutationsObserver_&&this.mutationsObserver_.disconnect(),this.mutationEventsAdded_&&document.removeEventListener("DOMSubtreeModified",this.refresh),this.mutationsObserver_=null,this.mutationEventsAdded_=!1,this.connected_=!1)},e.prototype.onTransitionEnd_=function(t){var r=t.propertyName,n=r===void 0?"":r,o=ba.some(function(i){return!!~n.indexOf(i)});o&&this.refresh()},e.getInstance=function(){return this.instance_||(this.instance_=new e),this.instance_},e.instance_=null,e}(),Gn=function(e,t){for(var r=0,n=Object.keys(t);r0},e}(),Jn=typeof WeakMap!="undefined"?new WeakMap:new Yn,Xn=function(){function e(t){if(!(this instanceof e))throw new TypeError("Cannot call a class as a function.");if(!arguments.length)throw new TypeError("1 argument required, but only 0 present.");var r=ga.getInstance(),n=new La(t,r,this);Jn.set(this,n)}return e}();["observe","unobserve","disconnect"].forEach(function(e){Xn.prototype[e]=function(){var t;return(t=Jn.get(this))[e].apply(t,arguments)}});var Aa=function(){return typeof nr.ResizeObserver!="undefined"?nr.ResizeObserver:Xn}(),Zn=Aa;var eo=new x,Ca=$(()=>k(new Zn(e=>{for(let t of e)eo.next(t)}))).pipe(g(e=>L(ze,k(e)).pipe(R(()=>e.disconnect()))),X(1));function he(e){return{width:e.offsetWidth,height:e.offsetHeight}}function ye(e){return Ca.pipe(S(t=>t.observe(e)),g(t=>eo.pipe(A(({target:r})=>r===e),R(()=>t.unobserve(e)),l(()=>he(e)))),V(he(e)))}function bt(e){return{width:e.scrollWidth,height:e.scrollHeight}}function ar(e){let t=e.parentElement;for(;t&&(e.scrollWidth<=t.scrollWidth&&e.scrollHeight<=t.scrollHeight);)t=(e=t).parentElement;return t?e:void 0}var to=new x,Ra=$(()=>k(new IntersectionObserver(e=>{for(let t of e)to.next(t)},{threshold:0}))).pipe(g(e=>L(ze,k(e)).pipe(R(()=>e.disconnect()))),X(1));function sr(e){return Ra.pipe(S(t=>t.observe(e)),g(t=>to.pipe(A(({target:r})=>r===e),R(()=>t.unobserve(e)),l(({isIntersecting:r})=>r))))}function ro(e,t=16){return dt(e).pipe(l(({y:r})=>{let n=he(e),o=bt(e);return r>=o.height-n.height-t}),J())}var cr={drawer:z("[data-md-toggle=drawer]"),search:z("[data-md-toggle=search]")};function no(e){return cr[e].checked}function Ke(e,t){cr[e].checked!==t&&cr[e].click()}function Ue(e){let t=cr[e];return b(t,"change").pipe(l(()=>t.checked),V(t.checked))}function ka(e,t){switch(e.constructor){case HTMLInputElement:return e.type==="radio"?/^Arrow/.test(t):!0;case HTMLSelectElement:case HTMLTextAreaElement:return!0;default:return e.isContentEditable}}function Ha(){return L(b(window,"compositionstart").pipe(l(()=>!0)),b(window,"compositionend").pipe(l(()=>!1))).pipe(V(!1))}function oo(){let e=b(window,"keydown").pipe(A(t=>!(t.metaKey||t.ctrlKey)),l(t=>({mode:no("search")?"search":"global",type:t.key,claim(){t.preventDefault(),t.stopPropagation()}})),A(({mode:t,type:r})=>{if(t==="global"){let n=_e();if(typeof n!="undefined")return!ka(n,r)}return!0}),pe());return Ha().pipe(g(t=>t?_:e))}function le(){return new URL(location.href)}function ot(e){location.href=e.href}function io(){return new x}function ao(e,t){if(typeof t=="string"||typeof t=="number")e.innerHTML+=t.toString();else if(t instanceof Node)e.appendChild(t);else if(Array.isArray(t))for(let r of t)ao(e,r)}function M(e,t,...r){let n=document.createElement(e);if(t)for(let o of Object.keys(t))typeof t[o]!="undefined"&&(typeof t[o]!="boolean"?n.setAttribute(o,t[o]):n.setAttribute(o,""));for(let o of r)ao(n,o);return n}function fr(e){if(e>999){let t=+((e-950)%1e3>99);return`${((e+1e-6)/1e3).toFixed(t)}k`}else return e.toString()}function so(){return location.hash.substring(1)}function Dr(e){let t=M("a",{href:e});t.addEventListener("click",r=>r.stopPropagation()),t.click()}function Pa(e){return L(b(window,"hashchange"),e).pipe(l(so),V(so()),A(t=>t.length>0),X(1))}function co(e){return Pa(e).pipe(l(t=>ce(`[id="${t}"]`)),A(t=>typeof t!="undefined"))}function Vr(e){let t=matchMedia(e);return er(r=>t.addListener(()=>r(t.matches))).pipe(V(t.matches))}function fo(){let e=matchMedia("print");return L(b(window,"beforeprint").pipe(l(()=>!0)),b(window,"afterprint").pipe(l(()=>!1))).pipe(V(e.matches))}function zr(e,t){return e.pipe(g(r=>r?t():_))}function ur(e,t={credentials:"same-origin"}){return ue(fetch(`${e}`,t)).pipe(fe(()=>_),g(r=>r.status!==200?Ot(()=>new Error(r.statusText)):k(r)))}function We(e,t){return ur(e,t).pipe(g(r=>r.json()),X(1))}function uo(e,t){let r=new DOMParser;return ur(e,t).pipe(g(n=>n.text()),l(n=>r.parseFromString(n,"text/xml")),X(1))}function pr(e){let t=M("script",{src:e});return $(()=>(document.head.appendChild(t),L(b(t,"load"),b(t,"error").pipe(g(()=>Ot(()=>new ReferenceError(`Invalid script: ${e}`))))).pipe(l(()=>{}),R(()=>document.head.removeChild(t)),ge(1))))}function po(){return{x:Math.max(0,scrollX),y:Math.max(0,scrollY)}}function lo(){return L(b(window,"scroll",{passive:!0}),b(window,"resize",{passive:!0})).pipe(l(po),V(po()))}function mo(){return{width:innerWidth,height:innerHeight}}function ho(){return b(window,"resize",{passive:!0}).pipe(l(mo),V(mo()))}function bo(){return Y([lo(),ho()]).pipe(l(([e,t])=>({offset:e,size:t})),X(1))}function lr(e,{viewport$:t,header$:r}){let n=t.pipe(ee("size")),o=Y([n,r]).pipe(l(()=>Xe(e)));return Y([r,t,o]).pipe(l(([{height:i},{offset:s,size:a},{x:f,y:c}])=>({offset:{x:s.x-f,y:s.y-c+i},size:a})))}(()=>{function e(n,o){parent.postMessage(n,o||"*")}function t(...n){return n.reduce((o,i)=>o.then(()=>new Promise(s=>{let a=document.createElement("script");a.src=i,a.onload=s,document.body.appendChild(a)})),Promise.resolve())}var r=class extends EventTarget{constructor(n){super(),this.url=n,this.m=i=>{i.source===this.w&&(this.dispatchEvent(new MessageEvent("message",{data:i.data})),this.onmessage&&this.onmessage(i))},this.e=(i,s,a,f,c)=>{if(s===`${this.url}`){let u=new ErrorEvent("error",{message:i,filename:s,lineno:a,colno:f,error:c});this.dispatchEvent(u),this.onerror&&this.onerror(u)}};let o=document.createElement("iframe");o.hidden=!0,document.body.appendChild(this.iframe=o),this.w.document.open(),this.w.document.write(` - + diff --git a/master/extensions/api/classes/Common.Catalog.CatalogEntity/index.html b/master/extensions/api/classes/Common.Catalog.CatalogEntity/index.html index 5dfe14f1e7..17230ab155 100644 --- a/master/extensions/api/classes/Common.Catalog.CatalogEntity/index.html +++ b/master/extensions/api/classes/Common.Catalog.CatalogEntity/index.html @@ -17,7 +17,7 @@ - + @@ -1200,7 +1200,7 @@ provided

- + diff --git a/master/extensions/api/classes/Common.Catalog.GeneralEntity/index.html b/master/extensions/api/classes/Common.Catalog.GeneralEntity/index.html index 7eef00028a..a32b4d12c7 100644 --- a/master/extensions/api/classes/Common.Catalog.GeneralEntity/index.html +++ b/master/extensions/api/classes/Common.Catalog.GeneralEntity/index.html @@ -17,7 +17,7 @@ - + @@ -1156,7 +1156,7 @@ provided

- + diff --git a/master/extensions/api/classes/Common.Catalog.KubernetesCluster/index.html b/master/extensions/api/classes/Common.Catalog.KubernetesCluster/index.html index b20dad06f1..951b1ad5a5 100644 --- a/master/extensions/api/classes/Common.Catalog.KubernetesCluster/index.html +++ b/master/extensions/api/classes/Common.Catalog.KubernetesCluster/index.html @@ -17,7 +17,7 @@ - + @@ -1255,7 +1255,7 @@ provided

- + diff --git a/master/extensions/api/classes/Common.Catalog.KubernetesClusterCategory/index.html b/master/extensions/api/classes/Common.Catalog.KubernetesClusterCategory/index.html index d571725d1d..1f323fc98b 100644 --- a/master/extensions/api/classes/Common.Catalog.KubernetesClusterCategory/index.html +++ b/master/extensions/api/classes/Common.Catalog.KubernetesClusterCategory/index.html @@ -17,7 +17,7 @@ - + @@ -1185,7 +1185,7 @@ The badge is displayed next to the Category name in the Catalog Category menu

{"base": "../../../..", "features": ["toc.autohide", "search.suggest", "search.highlight", "content.code.copy"], "search": "../../../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}} - + diff --git a/master/extensions/api/classes/Common.Catalog.WebLink/index.html b/master/extensions/api/classes/Common.Catalog.WebLink/index.html index a9493ce273..8c425f736c 100644 --- a/master/extensions/api/classes/Common.Catalog.WebLink/index.html +++ b/master/extensions/api/classes/Common.Catalog.WebLink/index.html @@ -17,7 +17,7 @@ - + @@ -1163,7 +1163,7 @@ provided

- + diff --git a/master/extensions/api/classes/Common.EventBus.EventEmitter/index.html b/master/extensions/api/classes/Common.EventBus.EventEmitter/index.html index dd6bf3ae79..c6f610fbab 100644 --- a/master/extensions/api/classes/Common.EventBus.EventEmitter/index.html +++ b/master/extensions/api/classes/Common.EventBus.EventEmitter/index.html @@ -17,7 +17,7 @@ - + @@ -1054,7 +1054,7 @@ - + diff --git a/master/extensions/api/classes/Common.LensExtension/index.html b/master/extensions/api/classes/Common.LensExtension/index.html index be6e2b462b..d9cfe4f325 100644 --- a/master/extensions/api/classes/Common.LensExtension/index.html +++ b/master/extensions/api/classes/Common.LensExtension/index.html @@ -17,7 +17,7 @@ - + @@ -1175,7 +1175,7 @@ folder name.

- + diff --git a/master/extensions/api/classes/Common.Store.ExtensionStore/index.html b/master/extensions/api/classes/Common.Store.ExtensionStore/index.html index 7a767406ce..2f0df04a11 100644 --- a/master/extensions/api/classes/Common.Store.ExtensionStore/index.html +++ b/master/extensions/api/classes/Common.Store.ExtensionStore/index.html @@ -17,7 +17,7 @@ - + @@ -1249,7 +1249,7 @@ - + diff --git a/master/extensions/api/classes/Common.Util.Singleton/index.html b/master/extensions/api/classes/Common.Util.Singleton/index.html index f314c3dafa..43e64d5492 100644 --- a/master/extensions/api/classes/Common.Util.Singleton/index.html +++ b/master/extensions/api/classes/Common.Util.Singleton/index.html @@ -17,7 +17,7 @@ - + @@ -1057,7 +1057,7 @@ only the first's arguments will be used.

- + diff --git a/master/extensions/api/classes/Main.Ipc/index.html b/master/extensions/api/classes/Main.Ipc/index.html index a9c93a0994..ec0627a0dd 100644 --- a/master/extensions/api/classes/Main.Ipc/index.html +++ b/master/extensions/api/classes/Main.Ipc/index.html @@ -17,7 +17,7 @@ - + @@ -1251,7 +1251,7 @@ only the first's arguments will be used.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.ClusterRole/index.html b/master/extensions/api/classes/Main.K8sApi.ClusterRole/index.html index ac04fc276d..1990aa5471 100644 --- a/master/extensions/api/classes/Main.K8sApi.ClusterRole/index.html +++ b/master/extensions/api/classes/Main.K8sApi.ClusterRole/index.html @@ -17,7 +17,7 @@ - + @@ -1808,7 +1808,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.ClusterRoleBinding/index.html b/master/extensions/api/classes/Main.K8sApi.ClusterRoleBinding/index.html index d448a79b34..8c96d2519d 100644 --- a/master/extensions/api/classes/Main.K8sApi.ClusterRoleBinding/index.html +++ b/master/extensions/api/classes/Main.K8sApi.ClusterRoleBinding/index.html @@ -17,7 +17,7 @@ - + @@ -1821,7 +1821,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.ConfigMap/index.html b/master/extensions/api/classes/Main.K8sApi.ConfigMap/index.html index aa88bb06e4..22f23b2231 100644 --- a/master/extensions/api/classes/Main.K8sApi.ConfigMap/index.html +++ b/master/extensions/api/classes/Main.K8sApi.ConfigMap/index.html @@ -17,7 +17,7 @@ - + @@ -1819,7 +1819,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.CronJob/index.html b/master/extensions/api/classes/Main.K8sApi.CronJob/index.html index 355e20f9aa..b755dbe080 100644 --- a/master/extensions/api/classes/Main.K8sApi.CronJob/index.html +++ b/master/extensions/api/classes/Main.K8sApi.CronJob/index.html @@ -17,7 +17,7 @@ - + @@ -1838,7 +1838,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.CustomResourceDefinition/index.html b/master/extensions/api/classes/Main.K8sApi.CustomResourceDefinition/index.html index a6c24ca2c8..e06d2aa745 100644 --- a/master/extensions/api/classes/Main.K8sApi.CustomResourceDefinition/index.html +++ b/master/extensions/api/classes/Main.K8sApi.CustomResourceDefinition/index.html @@ -17,7 +17,7 @@ - + @@ -1996,7 +1996,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.DaemonSet/index.html b/master/extensions/api/classes/Main.K8sApi.DaemonSet/index.html index f593b9b30c..723a8db19c 100644 --- a/master/extensions/api/classes/Main.K8sApi.DaemonSet/index.html +++ b/master/extensions/api/classes/Main.K8sApi.DaemonSet/index.html @@ -17,7 +17,7 @@ - + @@ -1864,7 +1864,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.Deployment/index.html b/master/extensions/api/classes/Main.K8sApi.Deployment/index.html index b58664a256..c1f15ccf18 100644 --- a/master/extensions/api/classes/Main.K8sApi.Deployment/index.html +++ b/master/extensions/api/classes/Main.K8sApi.Deployment/index.html @@ -17,7 +17,7 @@ - + @@ -1920,7 +1920,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.Endpoint/index.html b/master/extensions/api/classes/Main.K8sApi.Endpoint/index.html index ce8ef3071e..635d9da4b6 100644 --- a/master/extensions/api/classes/Main.K8sApi.Endpoint/index.html +++ b/master/extensions/api/classes/Main.K8sApi.Endpoint/index.html @@ -17,7 +17,7 @@ - + @@ -1810,7 +1810,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/index.html b/master/extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/index.html index 0d0604598a..17788ff1dc 100644 --- a/master/extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/index.html +++ b/master/extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/index.html @@ -17,7 +17,7 @@ - + @@ -1864,7 +1864,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.Ingress/index.html b/master/extensions/api/classes/Main.K8sApi.Ingress/index.html index a2ba9b49fa..ec0e590cbe 100644 --- a/master/extensions/api/classes/Main.K8sApi.Ingress/index.html +++ b/master/extensions/api/classes/Main.K8sApi.Ingress/index.html @@ -17,7 +17,7 @@ - + @@ -1851,7 +1851,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.Job/index.html b/master/extensions/api/classes/Main.K8sApi.Job/index.html index 8baaba6838..af4c67b149 100644 --- a/master/extensions/api/classes/Main.K8sApi.Job/index.html +++ b/master/extensions/api/classes/Main.K8sApi.Job/index.html @@ -17,7 +17,7 @@ - + @@ -1916,7 +1916,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.KubeEvent/index.html b/master/extensions/api/classes/Main.K8sApi.KubeEvent/index.html index 662fbec29b..fd77be84b6 100644 --- a/master/extensions/api/classes/Main.K8sApi.KubeEvent/index.html +++ b/master/extensions/api/classes/Main.K8sApi.KubeEvent/index.html @@ -17,7 +17,7 @@ - + @@ -1986,7 +1986,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.KubeObject/index.html b/master/extensions/api/classes/Main.K8sApi.KubeObject/index.html index ac372c21e8..dc70ee934d 100644 --- a/master/extensions/api/classes/Main.K8sApi.KubeObject/index.html +++ b/master/extensions/api/classes/Main.K8sApi.KubeObject/index.html @@ -17,7 +17,7 @@ - + @@ -1783,7 +1783,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.KubeObjectStore/index.html b/master/extensions/api/classes/Main.K8sApi.KubeObjectStore/index.html index 4fb45c2596..f7569bfb59 100644 --- a/master/extensions/api/classes/Main.K8sApi.KubeObjectStore/index.html +++ b/master/extensions/api/classes/Main.K8sApi.KubeObjectStore/index.html @@ -17,7 +17,7 @@ - + @@ -2485,7 +2485,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort) - + diff --git a/master/extensions/api/classes/Main.K8sApi.KubeStatus/index.html b/master/extensions/api/classes/Main.K8sApi.KubeStatus/index.html index fbaec72bb0..3e716a75cf 100644 --- a/master/extensions/api/classes/Main.K8sApi.KubeStatus/index.html +++ b/master/extensions/api/classes/Main.K8sApi.KubeStatus/index.html @@ -17,7 +17,7 @@ - + @@ -999,7 +999,7 @@ - + diff --git a/master/extensions/api/classes/Main.K8sApi.LimitRange/index.html b/master/extensions/api/classes/Main.K8sApi.LimitRange/index.html index 4374cafbf8..bd8ec86a7d 100644 --- a/master/extensions/api/classes/Main.K8sApi.LimitRange/index.html +++ b/master/extensions/api/classes/Main.K8sApi.LimitRange/index.html @@ -17,7 +17,7 @@ - + @@ -1812,7 +1812,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.Namespace/index.html b/master/extensions/api/classes/Main.K8sApi.Namespace/index.html index bf6ad27dd1..1e696085f5 100644 --- a/master/extensions/api/classes/Main.K8sApi.Namespace/index.html +++ b/master/extensions/api/classes/Main.K8sApi.Namespace/index.html @@ -17,7 +17,7 @@ - + @@ -1840,7 +1840,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.NetworkPolicy/index.html b/master/extensions/api/classes/Main.K8sApi.NetworkPolicy/index.html index 8faebbe65c..138355753c 100644 --- a/master/extensions/api/classes/Main.K8sApi.NetworkPolicy/index.html +++ b/master/extensions/api/classes/Main.K8sApi.NetworkPolicy/index.html @@ -17,7 +17,7 @@ - + @@ -1799,7 +1799,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.Node/index.html b/master/extensions/api/classes/Main.K8sApi.Node/index.html index 6d5405a827..b9e732ff96 100644 --- a/master/extensions/api/classes/Main.K8sApi.Node/index.html +++ b/master/extensions/api/classes/Main.K8sApi.Node/index.html @@ -17,7 +17,7 @@ - + @@ -1944,7 +1944,7 @@ of "True"

- + diff --git a/master/extensions/api/classes/Main.K8sApi.PersistentVolume/index.html b/master/extensions/api/classes/Main.K8sApi.PersistentVolume/index.html index 7325fa1739..03376ba53a 100644 --- a/master/extensions/api/classes/Main.K8sApi.PersistentVolume/index.html +++ b/master/extensions/api/classes/Main.K8sApi.PersistentVolume/index.html @@ -17,7 +17,7 @@ - + @@ -1853,7 +1853,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/index.html b/master/extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/index.html index 7b10c11a65..4229b8673e 100644 --- a/master/extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/index.html +++ b/master/extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/index.html @@ -17,7 +17,7 @@ - + @@ -1853,7 +1853,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.Pod/index.html b/master/extensions/api/classes/Main.K8sApi.Pod/index.html index 3a4333ccba..c313ea90fc 100644 --- a/master/extensions/api/classes/Main.K8sApi.Pod/index.html +++ b/master/extensions/api/classes/Main.K8sApi.Pod/index.html @@ -17,7 +17,7 @@ - + @@ -2197,7 +2197,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.PodDisruptionBudget/index.html b/master/extensions/api/classes/Main.K8sApi.PodDisruptionBudget/index.html index a0ce889818..368fb3140a 100644 --- a/master/extensions/api/classes/Main.K8sApi.PodDisruptionBudget/index.html +++ b/master/extensions/api/classes/Main.K8sApi.PodDisruptionBudget/index.html @@ -17,7 +17,7 @@ - + @@ -1838,7 +1838,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.PriorityClass/index.html b/master/extensions/api/classes/Main.K8sApi.PriorityClass/index.html index 05ee857fb4..e7417d0e20 100644 --- a/master/extensions/api/classes/Main.K8sApi.PriorityClass/index.html +++ b/master/extensions/api/classes/Main.K8sApi.PriorityClass/index.html @@ -17,7 +17,7 @@ - + @@ -1869,7 +1869,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.ReplicaSet/index.html b/master/extensions/api/classes/Main.K8sApi.ReplicaSet/index.html index da21ef7fe6..f492b5db9e 100644 --- a/master/extensions/api/classes/Main.K8sApi.ReplicaSet/index.html +++ b/master/extensions/api/classes/Main.K8sApi.ReplicaSet/index.html @@ -17,7 +17,7 @@ - + @@ -1903,7 +1903,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.ResourceQuota/index.html b/master/extensions/api/classes/Main.K8sApi.ResourceQuota/index.html index c95d15c0a3..ffe6ff6dc2 100644 --- a/master/extensions/api/classes/Main.K8sApi.ResourceQuota/index.html +++ b/master/extensions/api/classes/Main.K8sApi.ResourceQuota/index.html @@ -17,7 +17,7 @@ - + @@ -1786,7 +1786,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.ResourceStack/index.html b/master/extensions/api/classes/Main.K8sApi.ResourceStack/index.html index c2f06cca3f..0286ca4064 100644 --- a/master/extensions/api/classes/Main.K8sApi.ResourceStack/index.html +++ b/master/extensions/api/classes/Main.K8sApi.ResourceStack/index.html @@ -17,7 +17,7 @@ - + @@ -990,7 +990,7 @@ - + diff --git a/master/extensions/api/classes/Main.K8sApi.Role/index.html b/master/extensions/api/classes/Main.K8sApi.Role/index.html index ddf3d56520..b86575f2bf 100644 --- a/master/extensions/api/classes/Main.K8sApi.Role/index.html +++ b/master/extensions/api/classes/Main.K8sApi.Role/index.html @@ -17,7 +17,7 @@ - + @@ -1797,7 +1797,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.RoleBinding/index.html b/master/extensions/api/classes/Main.K8sApi.RoleBinding/index.html index a32e9a828f..71beeac29d 100644 --- a/master/extensions/api/classes/Main.K8sApi.RoleBinding/index.html +++ b/master/extensions/api/classes/Main.K8sApi.RoleBinding/index.html @@ -17,7 +17,7 @@ - + @@ -1821,7 +1821,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.Secret/index.html b/master/extensions/api/classes/Main.K8sApi.Secret/index.html index eb6da7c4c3..65ae149ded 100644 --- a/master/extensions/api/classes/Main.K8sApi.Secret/index.html +++ b/master/extensions/api/classes/Main.K8sApi.Secret/index.html @@ -17,7 +17,7 @@ - + @@ -1821,7 +1821,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.Service/index.html b/master/extensions/api/classes/Main.K8sApi.Service/index.html index f7df66571c..8aab530edc 100644 --- a/master/extensions/api/classes/Main.K8sApi.Service/index.html +++ b/master/extensions/api/classes/Main.K8sApi.Service/index.html @@ -17,7 +17,7 @@ - + @@ -1916,7 +1916,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.ServiceAccount/index.html b/master/extensions/api/classes/Main.K8sApi.ServiceAccount/index.html index 066066e9e8..f29ae5b448 100644 --- a/master/extensions/api/classes/Main.K8sApi.ServiceAccount/index.html +++ b/master/extensions/api/classes/Main.K8sApi.ServiceAccount/index.html @@ -17,7 +17,7 @@ - + @@ -1832,7 +1832,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.StatefulSet/index.html b/master/extensions/api/classes/Main.K8sApi.StatefulSet/index.html index 2997bc10e6..c025c60287 100644 --- a/master/extensions/api/classes/Main.K8sApi.StatefulSet/index.html +++ b/master/extensions/api/classes/Main.K8sApi.StatefulSet/index.html @@ -17,7 +17,7 @@ - + @@ -1877,7 +1877,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.K8sApi.StorageClass/index.html b/master/extensions/api/classes/Main.K8sApi.StorageClass/index.html index bd214ea68d..5d83086a18 100644 --- a/master/extensions/api/classes/Main.K8sApi.StorageClass/index.html +++ b/master/extensions/api/classes/Main.K8sApi.StorageClass/index.html @@ -17,7 +17,7 @@ - + @@ -1889,7 +1889,7 @@ creation timestamp of this object.

- + diff --git a/master/extensions/api/classes/Main.LensExtension/index.html b/master/extensions/api/classes/Main.LensExtension/index.html index d197530f3a..4125ee14ff 100644 --- a/master/extensions/api/classes/Main.LensExtension/index.html +++ b/master/extensions/api/classes/Main.LensExtension/index.html @@ -17,7 +17,7 @@ - + @@ -1342,7 +1342,7 @@ folder name.

- + diff --git a/master/extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/index.html b/master/extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/index.html index 162758adf2..e29521c5f2 100644 --- a/master/extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/index.html +++ b/master/extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/index.html @@ -17,7 +17,7 @@ - + @@ -1083,7 +1083,7 @@ added then it will not be added again.

- + diff --git a/master/extensions/api/classes/Renderer.Component.DrawerParamToggler/index.html b/master/extensions/api/classes/Renderer.Component.DrawerParamToggler/index.html index 124c5c273d..6396fbef29 100644 --- a/master/extensions/api/classes/Renderer.Component.DrawerParamToggler/index.html +++ b/master/extensions/api/classes/Renderer.Component.DrawerParamToggler/index.html @@ -17,7 +17,7 @@ - + @@ -1002,7 +1002,7 @@ - + diff --git a/master/extensions/api/classes/Renderer.Component.Input/index.html b/master/extensions/api/classes/Renderer.Component.Input/index.html index 0df8f2300a..2560eb3bc4 100644 --- a/master/extensions/api/classes/Renderer.Component.Input/index.html +++ b/master/extensions/api/classes/Renderer.Component.Input/index.html @@ -17,7 +17,7 @@ - + @@ -1417,7 +1417,7 @@ - + diff --git a/master/extensions/api/classes/Renderer.Component.MenuItem/index.html b/master/extensions/api/classes/Renderer.Component.MenuItem/index.html index 17f94f972d..6d2cebf75f 100644 --- a/master/extensions/api/classes/Renderer.Component.MenuItem/index.html +++ b/master/extensions/api/classes/Renderer.Component.MenuItem/index.html @@ -17,7 +17,7 @@ - + @@ -1102,7 +1102,7 @@ - + diff --git a/master/extensions/api/classes/Renderer.Component.NotificationsStore/index.html b/master/extensions/api/classes/Renderer.Component.NotificationsStore/index.html index b3a811e3a9..2d1069b88d 100644 --- a/master/extensions/api/classes/Renderer.Component.NotificationsStore/index.html +++ b/master/extensions/api/classes/Renderer.Component.NotificationsStore/index.html @@ -17,7 +17,7 @@ - + @@ -1070,7 +1070,7 @@ - + diff --git a/master/extensions/api/classes/Renderer.Component.PageLayout/index.html b/master/extensions/api/classes/Renderer.Component.PageLayout/index.html index d16c0c3494..88fe8d58da 100644 --- a/master/extensions/api/classes/Renderer.Component.PageLayout/index.html +++ b/master/extensions/api/classes/Renderer.Component.PageLayout/index.html @@ -17,7 +17,7 @@ - + @@ -1051,7 +1051,7 @@ - + diff --git a/master/extensions/api/classes/Renderer.Component.SettingLayout/index.html b/master/extensions/api/classes/Renderer.Component.SettingLayout/index.html index f8f378a389..77bf9a952d 100644 --- a/master/extensions/api/classes/Renderer.Component.SettingLayout/index.html +++ b/master/extensions/api/classes/Renderer.Component.SettingLayout/index.html @@ -17,7 +17,7 @@ - + @@ -1047,7 +1047,7 @@ - + diff --git a/master/extensions/api/classes/Renderer.Component.Slider/index.html b/master/extensions/api/classes/Renderer.Component.Slider/index.html index e848551c97..23c2f61b6b 100644 --- a/master/extensions/api/classes/Renderer.Component.Slider/index.html +++ b/master/extensions/api/classes/Renderer.Component.Slider/index.html @@ -17,7 +17,7 @@ - + @@ -985,7 +985,7 @@ - + diff --git a/master/extensions/api/classes/Renderer.Component.Spinner/index.html b/master/extensions/api/classes/Renderer.Component.Spinner/index.html index 3e90975b07..11c446e3a9 100644 --- a/master/extensions/api/classes/Renderer.Component.Spinner/index.html +++ b/master/extensions/api/classes/Renderer.Component.Spinner/index.html @@ -17,7 +17,7 @@ - + @@ -1004,7 +1004,7 @@ - + diff --git a/master/extensions/api/classes/Renderer.Component.Stepper/index.html b/master/extensions/api/classes/Renderer.Component.Stepper/index.html index 7cab8ff2ac..c887065e1b 100644 --- a/master/extensions/api/classes/Renderer.Component.Stepper/index.html +++ b/master/extensions/api/classes/Renderer.Component.Stepper/index.html @@ -17,7 +17,7 @@ - + @@ -951,7 +951,7 @@ - + diff --git a/master/extensions/api/classes/Renderer.Component.SubTitle/index.html b/master/extensions/api/classes/Renderer.Component.SubTitle/index.html index 872d0ba08a..c3cdd0424c 100644 --- a/master/extensions/api/classes/Renderer.Component.SubTitle/index.html +++ b/master/extensions/api/classes/Renderer.Component.SubTitle/index.html @@ -17,7 +17,7 @@ - + @@ -951,7 +951,7 @@ - + diff --git a/master/extensions/api/classes/Renderer.Component.Tab/index.html b/master/extensions/api/classes/Renderer.Component.Tab/index.html index 5dad857cd6..152d91edaa 100644 --- a/master/extensions/api/classes/Renderer.Component.Tab/index.html +++ b/master/extensions/api/classes/Renderer.Component.Tab/index.html @@ -17,7 +17,7 @@ - + @@ -1180,7 +1180,7 @@ - + diff --git a/master/extensions/api/classes/Renderer.Component.TableCell/index.html b/master/extensions/api/classes/Renderer.Component.TableCell/index.html index fa2f749f50..a13dafb742 100644 --- a/master/extensions/api/classes/Renderer.Component.TableCell/index.html +++ b/master/extensions/api/classes/Renderer.Component.TableCell/index.html @@ -17,7 +17,7 @@ - + @@ -980,7 +980,7 @@ - + diff --git a/master/extensions/api/classes/Renderer.Component.TableHead/index.html b/master/extensions/api/classes/Renderer.Component.TableHead/index.html index 1a6520cc74..630399d50e 100644 --- a/master/extensions/api/classes/Renderer.Component.TableHead/index.html +++ b/master/extensions/api/classes/Renderer.Component.TableHead/index.html @@ -17,7 +17,7 @@ - + @@ -985,7 +985,7 @@ - + diff --git a/master/extensions/api/classes/Renderer.Component.TableRow/index.html b/master/extensions/api/classes/Renderer.Component.TableRow/index.html index 6e53b65168..282867c60a 100644 --- a/master/extensions/api/classes/Renderer.Component.TableRow/index.html +++ b/master/extensions/api/classes/Renderer.Component.TableRow/index.html @@ -17,7 +17,7 @@ - + @@ -997,7 +997,7 @@ - + diff --git a/master/extensions/api/classes/Renderer.Component.Tabs/index.html b/master/extensions/api/classes/Renderer.Component.Tabs/index.html index ddfa627a5f..d2b9ab7c54 100644 --- a/master/extensions/api/classes/Renderer.Component.Tabs/index.html +++ b/master/extensions/api/classes/Renderer.Component.Tabs/index.html @@ -17,7 +17,7 @@ - + @@ -1031,7 +1031,7 @@ - + diff --git a/master/extensions/api/classes/Renderer.Component.TerminalStore/index.html b/master/extensions/api/classes/Renderer.Component.TerminalStore/index.html index 7b54217769..552740c23c 100644 --- a/master/extensions/api/classes/Renderer.Component.TerminalStore/index.html +++ b/master/extensions/api/classes/Renderer.Component.TerminalStore/index.html @@ -17,7 +17,7 @@ - + @@ -921,7 +921,7 @@ - + diff --git a/master/extensions/api/classes/Renderer.Component.Wizard/index.html b/master/extensions/api/classes/Renderer.Component.Wizard/index.html index ca28fbb11a..899b411e62 100644 --- a/master/extensions/api/classes/Renderer.Component.Wizard/index.html +++ b/master/extensions/api/classes/Renderer.Component.Wizard/index.html @@ -17,7 +17,7 @@ - + @@ -1218,7 +1218,7 @@ - + diff --git a/master/extensions/api/classes/Renderer.Component.WizardLayout/index.html b/master/extensions/api/classes/Renderer.Component.WizardLayout/index.html index 858988c466..7a5d6b428e 100644 --- a/master/extensions/api/classes/Renderer.Component.WizardLayout/index.html +++ b/master/extensions/api/classes/Renderer.Component.WizardLayout/index.html @@ -17,7 +17,7 @@ - + @@ -951,7 +951,7 @@ - + diff --git a/master/extensions/api/classes/Renderer.Component.WizardStep/index.html b/master/extensions/api/classes/Renderer.Component.WizardStep/index.html index a269ce66e2..7e9cb1f9fa 100644 --- a/master/extensions/api/classes/Renderer.Component.WizardStep/index.html +++ b/master/extensions/api/classes/Renderer.Component.WizardStep/index.html @@ -17,7 +17,7 @@ - + @@ -1141,7 +1141,7 @@ - + diff --git a/master/extensions/api/classes/Renderer.Ipc/index.html b/master/extensions/api/classes/Renderer.Ipc/index.html index 68addd46e8..07b8832fad 100644 --- a/master/extensions/api/classes/Renderer.Ipc/index.html +++ b/master/extensions/api/classes/Renderer.Ipc/index.html @@ -17,7 +17,7 @@ - + @@ -1256,7 +1256,7 @@ only the first's arguments will be used.

- + diff --git a/master/extensions/api/classes/Renderer.K8sApi.CRDResourceStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.CRDResourceStore/index.html index 061967d3d1..c846caa297 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.CRDResourceStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.CRDResourceStore/index.html @@ -17,7 +17,7 @@ - + @@ -2396,7 +2396,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort) - + diff --git a/master/extensions/api/classes/Renderer.K8sApi.CRDStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.CRDStore/index.html index e22c6882cf..424878ec8d 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.CRDStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.CRDStore/index.html @@ -17,7 +17,7 @@ - + @@ -2420,7 +2420,7 @@ - + diff --git a/master/extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/index.html index d2023cf3d6..67f097b1e2 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/index.html @@ -17,7 +17,7 @@ - + @@ -2363,7 +2363,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort) - + diff --git a/master/extensions/api/classes/Renderer.K8sApi.CronJobStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.CronJobStore/index.html index cb8f075410..7df3ffc03c 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.CronJobStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.CronJobStore/index.html @@ -17,7 +17,7 @@ - + @@ -2437,7 +2437,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort) - + diff --git a/master/extensions/api/classes/Renderer.K8sApi.DaemonSetStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.DaemonSetStore/index.html index 4a44eab607..7f57f5c49b 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.DaemonSetStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.DaemonSetStore/index.html @@ -17,7 +17,7 @@ - + @@ -2443,7 +2443,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort) - + diff --git a/master/extensions/api/classes/Renderer.K8sApi.DeploymentStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.DeploymentStore/index.html index 4657e36d54..155a1f577d 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.DeploymentStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.DeploymentStore/index.html @@ -17,7 +17,7 @@ - + @@ -2422,7 +2422,7 @@ - + diff --git a/master/extensions/api/classes/Renderer.K8sApi.EndpointStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.EndpointStore/index.html index 851e598091..c17ee4ad87 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.EndpointStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.EndpointStore/index.html @@ -17,7 +17,7 @@ - + @@ -2363,7 +2363,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort) - + diff --git a/master/extensions/api/classes/Renderer.K8sApi.EventStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.EventStore/index.html index c9949271b2..68884ef6d5 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.EventStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.EventStore/index.html @@ -17,7 +17,7 @@ - + @@ -2386,7 +2386,7 @@ - + diff --git a/master/extensions/api/classes/Renderer.K8sApi.HPAStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.HPAStore/index.html index e130f9e73c..57fc9cef31 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.HPAStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.HPAStore/index.html @@ -17,7 +17,7 @@ - + @@ -2363,7 +2363,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort) - + diff --git a/master/extensions/api/classes/Renderer.K8sApi.IngressClassStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.IngressClassStore/index.html index 760d40bae9..0c04d23d65 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.IngressClassStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.IngressClassStore/index.html @@ -17,7 +17,7 @@ - + @@ -2363,7 +2363,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort) - + diff --git a/master/extensions/api/classes/Renderer.K8sApi.IngressStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.IngressStore/index.html index 5b09638b2d..e56cad27ab 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.IngressStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.IngressStore/index.html @@ -17,7 +17,7 @@ - + @@ -2363,7 +2363,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort) - + diff --git a/master/extensions/api/classes/Renderer.K8sApi.JobStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.JobStore/index.html index 7169446a83..ca3336f124 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.JobStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.JobStore/index.html @@ -17,7 +17,7 @@ - + @@ -2475,7 +2475,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort) - + diff --git a/master/extensions/api/classes/Renderer.K8sApi.LimitRangesStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.LimitRangesStore/index.html index aaaebcae44..1c1faa1c49 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.LimitRangesStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.LimitRangesStore/index.html @@ -17,7 +17,7 @@ - + @@ -2363,7 +2363,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort) - + diff --git a/master/extensions/api/classes/Renderer.K8sApi.NamespaceStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.NamespaceStore/index.html index 0aef32396f..964a90c908 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.NamespaceStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.NamespaceStore/index.html @@ -17,7 +17,7 @@ - + @@ -2751,7 +2751,7 @@ explicitly deselected.

- + diff --git a/master/extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/index.html index 192986c84d..48b2b1f5a0 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/index.html @@ -17,7 +17,7 @@ - + @@ -2363,7 +2363,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort) - + diff --git a/master/extensions/api/classes/Renderer.K8sApi.NodesStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.NodesStore/index.html index efe8a5cf2f..cf56bc5460 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.NodesStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.NodesStore/index.html @@ -17,7 +17,7 @@ - + @@ -2402,7 +2402,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort) - + diff --git a/master/extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/index.html index 4cbee70356..705d57065e 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/index.html @@ -17,7 +17,7 @@ - + @@ -2391,7 +2391,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort) - + diff --git a/master/extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/index.html index a0674778e9..8b44147aa3 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/index.html @@ -17,7 +17,7 @@ - + @@ -2363,7 +2363,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort) - + diff --git a/master/extensions/api/classes/Renderer.K8sApi.PodsStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.PodsStore/index.html index a5c61a3b6b..748cd37578 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.PodsStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.PodsStore/index.html @@ -17,7 +17,7 @@ - + @@ -2560,7 +2560,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort) - + diff --git a/master/extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/index.html index 0f800e7d6d..232ce9829d 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/index.html @@ -17,7 +17,7 @@ - + @@ -2363,7 +2363,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort) - + diff --git a/master/extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/index.html index d37dab596f..4fb2766e26 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/index.html @@ -17,7 +17,7 @@ - + @@ -2471,7 +2471,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort) - + diff --git a/master/extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/index.html index 2d5e0dd370..f05478f93e 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/index.html @@ -17,7 +17,7 @@ - + @@ -2363,7 +2363,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort) - + diff --git a/master/extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/index.html index ab61b2446a..dfd5618281 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/index.html @@ -17,7 +17,7 @@ - + @@ -2411,7 +2411,7 @@ - + diff --git a/master/extensions/api/classes/Renderer.K8sApi.RolesStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.RolesStore/index.html index 7c8e70d035..7e9b7539a5 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.RolesStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.RolesStore/index.html @@ -17,7 +17,7 @@ - + @@ -2347,7 +2347,7 @@ - + diff --git a/master/extensions/api/classes/Renderer.K8sApi.SecretsStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.SecretsStore/index.html index d83746f35b..0b17d80935 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.SecretsStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.SecretsStore/index.html @@ -17,7 +17,7 @@ - + @@ -2363,7 +2363,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort) - + diff --git a/master/extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/index.html index 32f37867d9..54cc5408d8 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/index.html @@ -17,7 +17,7 @@ - + @@ -2359,7 +2359,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort) - + diff --git a/master/extensions/api/classes/Renderer.K8sApi.ServiceStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.ServiceStore/index.html index b141ef7735..15ecbfa851 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.ServiceStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.ServiceStore/index.html @@ -17,7 +17,7 @@ - + @@ -2363,7 +2363,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort) - + diff --git a/master/extensions/api/classes/Renderer.K8sApi.StatefulSetStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.StatefulSetStore/index.html index a296b0faba..df6df5dcf9 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.StatefulSetStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.StatefulSetStore/index.html @@ -17,7 +17,7 @@ - + @@ -2443,7 +2443,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort) - + diff --git a/master/extensions/api/classes/Renderer.K8sApi.StorageClassStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.StorageClassStore/index.html index 0171140946..a5fcf6c1dd 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.StorageClassStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.StorageClassStore/index.html @@ -17,7 +17,7 @@ - + @@ -2391,7 +2391,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort) - + diff --git a/master/extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/index.html index 83bbdec4cb..4b81ab0a53 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/index.html @@ -17,7 +17,7 @@ - + @@ -2363,7 +2363,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort) - + diff --git a/master/extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/index.html index 3439cbcca9..18be38b2b5 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/index.html @@ -17,7 +17,7 @@ - + @@ -2363,7 +2363,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort) - + diff --git a/master/extensions/api/classes/Renderer.LensExtension/index.html b/master/extensions/api/classes/Renderer.LensExtension/index.html index 4c50489980..f71e739135 100644 --- a/master/extensions/api/classes/Renderer.LensExtension/index.html +++ b/master/extensions/api/classes/Renderer.LensExtension/index.html @@ -17,7 +17,7 @@ - + @@ -1555,7 +1555,7 @@ called when the extension is created within a cluster frame.

- + diff --git a/master/extensions/api/classes/Renderer.Navigation.PageParam/index.html b/master/extensions/api/classes/Renderer.Navigation.PageParam/index.html index d7ff502389..edd48816f7 100644 --- a/master/extensions/api/classes/Renderer.Navigation.PageParam/index.html +++ b/master/extensions/api/classes/Renderer.Navigation.PageParam/index.html @@ -17,7 +17,7 @@ - + @@ -1231,7 +1231,7 @@ - + diff --git a/master/extensions/api/enums/Renderer.Component.NotificationStatus/index.html b/master/extensions/api/enums/Renderer.Component.NotificationStatus/index.html index 872ad3090e..5c2fa36554 100644 --- a/master/extensions/api/enums/Renderer.Component.NotificationStatus/index.html +++ b/master/extensions/api/enums/Renderer.Component.NotificationStatus/index.html @@ -17,7 +17,7 @@ - + @@ -881,7 +881,7 @@ - + diff --git a/master/extensions/api/enums/Renderer.Component.TooltipPosition/index.html b/master/extensions/api/enums/Renderer.Component.TooltipPosition/index.html index c15dd4883d..5a8334bf9d 100644 --- a/master/extensions/api/enums/Renderer.Component.TooltipPosition/index.html +++ b/master/extensions/api/enums/Renderer.Component.TooltipPosition/index.html @@ -17,7 +17,7 @@ - + @@ -936,7 +936,7 @@ - + diff --git a/master/extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/index.html b/master/extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/index.html index 587fa21785..6ec1d31f13 100644 --- a/master/extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/index.html +++ b/master/extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/index.html @@ -17,7 +17,7 @@ - + @@ -881,7 +881,7 @@ - + diff --git a/master/extensions/api/index.html b/master/extensions/api/index.html index 690c5a7699..360e687c13 100644 --- a/master/extensions/api/index.html +++ b/master/extensions/api/index.html @@ -19,7 +19,7 @@ - + @@ -866,7 +866,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/index.html b/master/extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/index.html index 50eab4c8d1..6b5ba4d295 100644 --- a/master/extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/index.html +++ b/master/extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/index.html @@ -17,7 +17,7 @@ - + @@ -933,7 +933,7 @@ view.

- + diff --git a/master/extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/index.html b/master/extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/index.html index 13654f5eed..90b630f7e2 100644 --- a/master/extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/index.html +++ b/master/extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/index.html @@ -17,7 +17,7 @@ - + @@ -873,7 +873,7 @@ value. This will also be used for the catalog menu.

- + diff --git a/master/extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/index.html b/master/extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/index.html index 1baaafc223..08316962b8 100644 --- a/master/extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/index.html +++ b/master/extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/index.html @@ -17,7 +17,7 @@ - + @@ -921,7 +921,7 @@ For example, if group = "entity.k8slens.dev" and there is an entry - + diff --git a/master/extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/index.html b/master/extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/index.html index cc45c5331d..995f6a3262 100644 --- a/master/extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/index.html +++ b/master/extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/index.html @@ -17,7 +17,7 @@ - + @@ -879,7 +879,7 @@ a DNS label and SHOULD be of the form vN, vNalphaY, or - + diff --git a/master/extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/index.html b/master/extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/index.html index b44122e5ed..d0a529ff2e 100644 --- a/master/extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/index.html +++ b/master/extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/index.html @@ -17,7 +17,7 @@ - + @@ -908,7 +908,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/index.html b/master/extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/index.html index 896c488c33..b5900e6e6c 100644 --- a/master/extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/index.html +++ b/master/extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/index.html @@ -17,7 +17,7 @@ - + @@ -946,7 +946,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/index.html b/master/extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/index.html index ae368c522a..aa46319691 100644 --- a/master/extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/index.html +++ b/master/extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/index.html @@ -17,7 +17,7 @@ - + @@ -889,7 +889,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/index.html b/master/extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/index.html index 6f2045e554..3c254c9c25 100644 --- a/master/extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/index.html +++ b/master/extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/index.html @@ -17,7 +17,7 @@ - + @@ -927,7 +927,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/index.html b/master/extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/index.html index 80de03b6d1..601a728da0 100644 --- a/master/extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/index.html +++ b/master/extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/index.html @@ -17,7 +17,7 @@ - + @@ -871,7 +871,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/index.html b/master/extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/index.html index f198557f9f..690f586ab0 100644 --- a/master/extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/index.html +++ b/master/extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/index.html @@ -17,7 +17,7 @@ - + @@ -891,7 +891,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Catalog.CatalogEntityData/index.html b/master/extensions/api/interfaces/Common.Catalog.CatalogEntityData/index.html index c8366fe382..f506b40e6f 100644 --- a/master/extensions/api/interfaces/Common.Catalog.CatalogEntityData/index.html +++ b/master/extensions/api/interfaces/Common.Catalog.CatalogEntityData/index.html @@ -17,7 +17,7 @@ - + @@ -911,7 +911,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/index.html b/master/extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/index.html index 3552d2c8d0..82fd2ff715 100644 --- a/master/extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/index.html +++ b/master/extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/index.html @@ -17,7 +17,7 @@ - + @@ -881,7 +881,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/index.html b/master/extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/index.html index e284907bb0..e5af5a4065 100644 --- a/master/extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/index.html +++ b/master/extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/index.html @@ -17,7 +17,7 @@ - + @@ -927,7 +927,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/index.html b/master/extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/index.html index f6cbb539f9..e5ae1fee01 100644 --- a/master/extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/index.html +++ b/master/extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/index.html @@ -17,7 +17,7 @@ - + @@ -859,7 +859,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/index.html b/master/extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/index.html index 427f43b41b..8bf6d324b2 100644 --- a/master/extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/index.html +++ b/master/extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/index.html @@ -17,7 +17,7 @@ - + @@ -896,7 +896,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/index.html b/master/extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/index.html index ea3edfe83b..bdc2dae523 100644 --- a/master/extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/index.html +++ b/master/extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/index.html @@ -17,7 +17,7 @@ - + @@ -919,7 +919,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/index.html b/master/extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/index.html index 1bce4f399c..2480e7a2c1 100644 --- a/master/extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/index.html +++ b/master/extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/index.html @@ -17,7 +17,7 @@ - + @@ -996,7 +996,7 @@ elements of the previous index.

- + diff --git a/master/extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/index.html b/master/extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/index.html index 110e60ebda..7831095a11 100644 --- a/master/extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/index.html +++ b/master/extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/index.html @@ -17,7 +17,7 @@ - + @@ -901,7 +901,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/index.html b/master/extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/index.html index 73820ad2b2..3f69a1362e 100644 --- a/master/extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/index.html +++ b/master/extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/index.html @@ -17,7 +17,7 @@ - + @@ -960,7 +960,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/index.html b/master/extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/index.html index de2263675b..a0518d7a53 100644 --- a/master/extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/index.html +++ b/master/extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/index.html @@ -17,7 +17,7 @@ - + @@ -897,7 +897,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/index.html b/master/extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/index.html index 92d02368f3..0ea16a60dd 100644 --- a/master/extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/index.html +++ b/master/extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/index.html @@ -17,7 +17,7 @@ - + @@ -957,7 +957,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/index.html b/master/extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/index.html index ba396fe476..a1159a7e1b 100644 --- a/master/extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/index.html +++ b/master/extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/index.html @@ -17,7 +17,7 @@ - + @@ -928,7 +928,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Catalog.TitleCellProps/index.html b/master/extensions/api/interfaces/Common.Catalog.TitleCellProps/index.html index a3f60c2b8a..577ef9fd20 100644 --- a/master/extensions/api/interfaces/Common.Catalog.TitleCellProps/index.html +++ b/master/extensions/api/interfaces/Common.Catalog.TitleCellProps/index.html @@ -17,7 +17,7 @@ - + @@ -882,7 +882,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Catalog.WebLinkSpec/index.html b/master/extensions/api/interfaces/Common.Catalog.WebLinkSpec/index.html index 2f9849d3f3..667b280967 100644 --- a/master/extensions/api/interfaces/Common.Catalog.WebLinkSpec/index.html +++ b/master/extensions/api/interfaces/Common.Catalog.WebLinkSpec/index.html @@ -17,7 +17,7 @@ - + @@ -859,7 +859,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Catalog.WebLinkStatus/index.html b/master/extensions/api/interfaces/Common.Catalog.WebLinkStatus/index.html index e49b34aff3..db25d434f2 100644 --- a/master/extensions/api/interfaces/Common.Catalog.WebLinkStatus/index.html +++ b/master/extensions/api/interfaces/Common.Catalog.WebLinkStatus/index.html @@ -17,7 +17,7 @@ - + @@ -928,7 +928,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.EventBus.AppEvent/index.html b/master/extensions/api/interfaces/Common.EventBus.AppEvent/index.html index 7e6438e9c1..a8af9ea06c 100644 --- a/master/extensions/api/interfaces/Common.EventBus.AppEvent/index.html +++ b/master/extensions/api/interfaces/Common.EventBus.AppEvent/index.html @@ -17,7 +17,7 @@ - + @@ -893,7 +893,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.EventBus.EventEmitterOptions/index.html b/master/extensions/api/interfaces/Common.EventBus.EventEmitterOptions/index.html index 8bce68c4b3..92194f17d9 100644 --- a/master/extensions/api/interfaces/Common.EventBus.EventEmitterOptions/index.html +++ b/master/extensions/api/interfaces/Common.EventBus.EventEmitterOptions/index.html @@ -17,7 +17,7 @@ - + @@ -870,7 +870,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.LensExtensionManifest/index.html b/master/extensions/api/interfaces/Common.LensExtensionManifest/index.html index d908a1fe46..38a7fd8e4b 100644 --- a/master/extensions/api/interfaces/Common.LensExtensionManifest/index.html +++ b/master/extensions/api/interfaces/Common.LensExtensionManifest/index.html @@ -17,7 +17,7 @@ - + @@ -979,7 +979,7 @@ Useful if extension is renamed but the data should not be lost.

- + diff --git a/master/extensions/api/interfaces/Common.Logger/index.html b/master/extensions/api/interfaces/Common.Logger/index.html index c9a07646b7..4aff174eb1 100644 --- a/master/extensions/api/interfaces/Common.Logger/index.html +++ b/master/extensions/api/interfaces/Common.Logger/index.html @@ -17,7 +17,7 @@ - + @@ -1020,7 +1020,7 @@ Licensed under MIT License. See LICENSE in root directory for more information.< - + diff --git a/master/extensions/api/interfaces/Common.Store.ExtensionStoreParams/index.html b/master/extensions/api/interfaces/Common.Store.ExtensionStoreParams/index.html index b37d8692cb..cfe1d06c8e 100644 --- a/master/extensions/api/interfaces/Common.Store.ExtensionStoreParams/index.html +++ b/master/extensions/api/interfaces/Common.Store.ExtensionStoreParams/index.html @@ -17,7 +17,7 @@ - + @@ -949,7 +949,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Store.PersistentStorageParams/index.html b/master/extensions/api/interfaces/Common.Store.PersistentStorageParams/index.html index c43313bb5a..1315837e6d 100644 --- a/master/extensions/api/interfaces/Common.Store.PersistentStorageParams/index.html +++ b/master/extensions/api/interfaces/Common.Store.PersistentStorageParams/index.html @@ -17,7 +17,7 @@ - + @@ -1009,7 +1009,7 @@ produce a JSON serializable object representation of the current state.

- + diff --git a/master/extensions/api/interfaces/Common.Types.AppPreferenceComponents/index.html b/master/extensions/api/interfaces/Common.Types.AppPreferenceComponents/index.html index 5c2e1ffd00..31fe951e48 100644 --- a/master/extensions/api/interfaces/Common.Types.AppPreferenceComponents/index.html +++ b/master/extensions/api/interfaces/Common.Types.AppPreferenceComponents/index.html @@ -17,7 +17,7 @@ - + @@ -870,7 +870,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Types.AppPreferenceRegistration/index.html b/master/extensions/api/interfaces/Common.Types.AppPreferenceRegistration/index.html index 4acf156449..be20f994a5 100644 --- a/master/extensions/api/interfaces/Common.Types.AppPreferenceRegistration/index.html +++ b/master/extensions/api/interfaces/Common.Types.AppPreferenceRegistration/index.html @@ -17,7 +17,7 @@ - + @@ -892,7 +892,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/index.html b/master/extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/index.html index 85dc9bb5e4..31520cdd82 100644 --- a/master/extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/index.html +++ b/master/extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/index.html @@ -17,7 +17,7 @@ - + @@ -859,7 +859,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/index.html b/master/extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/index.html index 1d308b2ec5..154ed5cab8 100644 --- a/master/extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/index.html +++ b/master/extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/index.html @@ -17,7 +17,7 @@ - + @@ -925,7 +925,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/index.html b/master/extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/index.html index 45cedf27c2..d860b563f4 100644 --- a/master/extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/index.html +++ b/master/extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/index.html @@ -17,7 +17,7 @@ - + @@ -860,7 +860,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Types.CustomCategoryViewProps/index.html b/master/extensions/api/interfaces/Common.Types.CustomCategoryViewProps/index.html index 2ffea28015..0ad8b1ad74 100644 --- a/master/extensions/api/interfaces/Common.Types.CustomCategoryViewProps/index.html +++ b/master/extensions/api/interfaces/Common.Types.CustomCategoryViewProps/index.html @@ -17,7 +17,7 @@ - + @@ -861,7 +861,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/index.html b/master/extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/index.html index d105c42ec7..7443415f40 100644 --- a/master/extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/index.html +++ b/master/extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/index.html @@ -17,7 +17,7 @@ - + @@ -904,7 +904,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/index.html b/master/extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/index.html index 80127cfbd6..2581200c3f 100644 --- a/master/extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/index.html +++ b/master/extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/index.html @@ -17,7 +17,7 @@ - + @@ -916,7 +916,7 @@ the kube object details page.

- + diff --git a/master/extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/index.html b/master/extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/index.html index 947c7d9f2e..c0e69b1367 100644 --- a/master/extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/index.html +++ b/master/extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/index.html @@ -17,7 +17,7 @@ - + @@ -881,7 +881,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/index.html b/master/extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/index.html index 59ddb9ca3b..fbe72cc8b4 100644 --- a/master/extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/index.html +++ b/master/extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/index.html @@ -17,7 +17,7 @@ - + @@ -925,7 +925,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Types.KubeObjectHandlers/index.html b/master/extensions/api/interfaces/Common.Types.KubeObjectHandlers/index.html index ba198d3fe1..b5cf05c248 100644 --- a/master/extensions/api/interfaces/Common.Types.KubeObjectHandlers/index.html +++ b/master/extensions/api/interfaces/Common.Types.KubeObjectHandlers/index.html @@ -17,7 +17,7 @@ - + @@ -859,7 +859,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/index.html b/master/extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/index.html index 05a0e87b7a..dd52caa3db 100644 --- a/master/extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/index.html +++ b/master/extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/index.html @@ -17,7 +17,7 @@ - + @@ -859,7 +859,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/index.html b/master/extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/index.html index c5c323072d..a589ce882d 100644 --- a/master/extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/index.html +++ b/master/extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/index.html @@ -17,7 +17,7 @@ - + @@ -892,7 +892,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/index.html b/master/extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/index.html index c89859e189..b1d8fe5bcb 100644 --- a/master/extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/index.html +++ b/master/extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/index.html @@ -17,7 +17,7 @@ - + @@ -889,7 +889,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/index.html b/master/extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/index.html index 1822c84eea..832b7e6ebe 100644 --- a/master/extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/index.html +++ b/master/extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/index.html @@ -17,7 +17,7 @@ - + @@ -911,7 +911,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Types.PageComponentProps/index.html b/master/extensions/api/interfaces/Common.Types.PageComponentProps/index.html index 4c31db7ef5..f7a172bfe5 100644 --- a/master/extensions/api/interfaces/Common.Types.PageComponentProps/index.html +++ b/master/extensions/api/interfaces/Common.Types.PageComponentProps/index.html @@ -17,7 +17,7 @@ - + @@ -881,7 +881,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Types.PageComponents/index.html b/master/extensions/api/interfaces/Common.Types.PageComponents/index.html index 2ed3dd1c36..80116653fa 100644 --- a/master/extensions/api/interfaces/Common.Types.PageComponents/index.html +++ b/master/extensions/api/interfaces/Common.Types.PageComponents/index.html @@ -17,7 +17,7 @@ - + @@ -859,7 +859,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Types.PageParams/index.html b/master/extensions/api/interfaces/Common.Types.PageParams/index.html index 5cc988ac47..7a787f4086 100644 --- a/master/extensions/api/interfaces/Common.Types.PageParams/index.html +++ b/master/extensions/api/interfaces/Common.Types.PageParams/index.html @@ -17,7 +17,7 @@ - + @@ -842,7 +842,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Types.PageRegistration/index.html b/master/extensions/api/interfaces/Common.Types.PageRegistration/index.html index cfad8d1cd6..12045ea8ba 100644 --- a/master/extensions/api/interfaces/Common.Types.PageRegistration/index.html +++ b/master/extensions/api/interfaces/Common.Types.PageRegistration/index.html @@ -17,7 +17,7 @@ - + @@ -894,7 +894,7 @@ When not provided, first registered page without "id" would be used for page-men - + diff --git a/master/extensions/api/interfaces/Common.Types.PageTarget/index.html b/master/extensions/api/interfaces/Common.Types.PageTarget/index.html index ab2a921fe2..71139c5ef2 100644 --- a/master/extensions/api/interfaces/Common.Types.PageTarget/index.html +++ b/master/extensions/api/interfaces/Common.Types.PageTarget/index.html @@ -17,7 +17,7 @@ - + @@ -881,7 +881,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/index.html b/master/extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/index.html index 297ca084f7..4305c285d1 100644 --- a/master/extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/index.html +++ b/master/extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/index.html @@ -17,7 +17,7 @@ - + @@ -872,7 +872,7 @@ a handler to a specific path or dynamic path.

- + diff --git a/master/extensions/api/interfaces/Common.Types.ProtocolRouteHandler/index.html b/master/extensions/api/interfaces/Common.Types.ProtocolRouteHandler/index.html index 754d568f7b..2fae174068 100644 --- a/master/extensions/api/interfaces/Common.Types.ProtocolRouteHandler/index.html +++ b/master/extensions/api/interfaces/Common.Types.ProtocolRouteHandler/index.html @@ -17,7 +17,7 @@ - + @@ -853,7 +853,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Types.ProtocolRouteParams/index.html b/master/extensions/api/interfaces/Common.Types.ProtocolRouteParams/index.html index f3238767f2..f3ddb75a78 100644 --- a/master/extensions/api/interfaces/Common.Types.ProtocolRouteParams/index.html +++ b/master/extensions/api/interfaces/Common.Types.ProtocolRouteParams/index.html @@ -17,7 +17,7 @@ - + @@ -891,7 +891,7 @@ segments.

- + diff --git a/master/extensions/api/interfaces/Common.Types.RegisteredPage/index.html b/master/extensions/api/interfaces/Common.Types.RegisteredPage/index.html index cb72fb1841..a2996d4a79 100644 --- a/master/extensions/api/interfaces/Common.Types.RegisteredPage/index.html +++ b/master/extensions/api/interfaces/Common.Types.RegisteredPage/index.html @@ -17,7 +17,7 @@ - + @@ -903,7 +903,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Types.ShellEnvContext/index.html b/master/extensions/api/interfaces/Common.Types.ShellEnvContext/index.html index cc37da32d8..8706093f30 100644 --- a/master/extensions/api/interfaces/Common.Types.ShellEnvContext/index.html +++ b/master/extensions/api/interfaces/Common.Types.ShellEnvContext/index.html @@ -17,7 +17,7 @@ - + @@ -859,7 +859,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Types.StatusBarRegistration/index.html b/master/extensions/api/interfaces/Common.Types.StatusBarRegistration/index.html index 4622c737c1..4da981ab45 100644 --- a/master/extensions/api/interfaces/Common.Types.StatusBarRegistration/index.html +++ b/master/extensions/api/interfaces/Common.Types.StatusBarRegistration/index.html @@ -17,7 +17,7 @@ - + @@ -886,7 +886,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Types.TrayMenuRegistration/index.html b/master/extensions/api/interfaces/Common.Types.TrayMenuRegistration/index.html index a180b99c65..9d2eb7b675 100644 --- a/master/extensions/api/interfaces/Common.Types.TrayMenuRegistration/index.html +++ b/master/extensions/api/interfaces/Common.Types.TrayMenuRegistration/index.html @@ -17,7 +17,7 @@ - + @@ -955,7 +955,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Util.Disposable/index.html b/master/extensions/api/interfaces/Common.Util.Disposable/index.html index 52e5d22553..2b0a501a40 100644 --- a/master/extensions/api/interfaces/Common.Util.Disposable/index.html +++ b/master/extensions/api/interfaces/Common.Util.Disposable/index.html @@ -17,7 +17,7 @@ - + @@ -861,7 +861,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Util.Disposer/index.html b/master/extensions/api/interfaces/Common.Util.Disposer/index.html index 5ec4790178..1f8a08253b 100644 --- a/master/extensions/api/interfaces/Common.Util.Disposer/index.html +++ b/master/extensions/api/interfaces/Common.Util.Disposer/index.html @@ -17,7 +17,7 @@ - + @@ -848,7 +848,7 @@ - + diff --git a/master/extensions/api/interfaces/Common.Util.ExtendableDisposer/index.html b/master/extensions/api/interfaces/Common.Util.ExtendableDisposer/index.html index c4ecaf4230..844cc9a654 100644 --- a/master/extensions/api/interfaces/Common.Util.ExtendableDisposer/index.html +++ b/master/extensions/api/interfaces/Common.Util.ExtendableDisposer/index.html @@ -17,7 +17,7 @@ - + @@ -913,7 +913,7 @@ - + diff --git a/master/extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/index.html b/master/extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/index.html index 179e23127d..cd98b4fe36 100644 --- a/master/extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/index.html +++ b/master/extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/index.html @@ -17,7 +17,7 @@ - + @@ -919,7 +919,7 @@ - + diff --git a/master/extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/index.html b/master/extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/index.html index f42c732d99..a4a17723bf 100644 --- a/master/extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/index.html +++ b/master/extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/index.html @@ -17,7 +17,7 @@ - + @@ -1137,7 +1137,7 @@ Populated by the system.

- + diff --git a/master/extensions/api/interfaces/Main.K8sApi.ExternalKubeApiOptions/index.html b/master/extensions/api/interfaces/Main.K8sApi.ExternalKubeApiOptions/index.html index 77bf8950bf..920fbdf9b5 100644 --- a/master/extensions/api/interfaces/Main.K8sApi.ExternalKubeApiOptions/index.html +++ b/master/extensions/api/interfaces/Main.K8sApi.ExternalKubeApiOptions/index.html @@ -17,7 +17,7 @@ - + @@ -865,7 +865,7 @@ made. This is true by default to maintain backwards compatibility.< - + diff --git a/master/extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/index.html b/master/extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/index.html index ac4989a256..8d2f84ea46 100644 --- a/master/extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/index.html +++ b/master/extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/index.html @@ -17,7 +17,7 @@ - + @@ -876,7 +876,7 @@ - + diff --git a/master/extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/index.html b/master/extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/index.html index b7c4cb3c7c..1318cb8aaa 100644 --- a/master/extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/index.html +++ b/master/extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/index.html @@ -17,7 +17,7 @@ - + @@ -874,7 +874,7 @@ - + diff --git a/master/extensions/api/interfaces/Main.K8sApi.IPodContainer/index.html b/master/extensions/api/interfaces/Main.K8sApi.IPodContainer/index.html index 534a99be43..a53f7eabaf 100644 --- a/master/extensions/api/interfaces/Main.K8sApi.IPodContainer/index.html +++ b/master/extensions/api/interfaces/Main.K8sApi.IPodContainer/index.html @@ -17,7 +17,7 @@ - + @@ -1173,7 +1173,7 @@ which might be configured in the container image. Cannot be updated.

- + diff --git a/master/extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/index.html b/master/extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/index.html index 3be7792a8f..405fda393f 100644 --- a/master/extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/index.html +++ b/master/extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/index.html @@ -17,7 +17,7 @@ - + @@ -947,7 +947,7 @@ - + diff --git a/master/extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/index.html b/master/extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/index.html index e11732a13a..6f8389c311 100644 --- a/master/extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/index.html +++ b/master/extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/index.html @@ -17,7 +17,7 @@ - + @@ -931,7 +931,7 @@ clientCertificateData, clientKeyData and caData are ignored.

- + diff --git a/master/extensions/api/interfaces/Main.K8sApi.ISecretRef/index.html b/master/extensions/api/interfaces/Main.K8sApi.ISecretRef/index.html index 47ff99aef9..2e59497f6e 100644 --- a/master/extensions/api/interfaces/Main.K8sApi.ISecretRef/index.html +++ b/master/extensions/api/interfaces/Main.K8sApi.ISecretRef/index.html @@ -17,7 +17,7 @@ - + @@ -870,7 +870,7 @@ - + diff --git a/master/extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/index.html b/master/extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/index.html index 7ad2d50130..c61e9c991e 100644 --- a/master/extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/index.html +++ b/master/extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/index.html @@ -17,7 +17,7 @@ - + @@ -902,7 +902,7 @@ - + diff --git a/master/extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/index.html b/master/extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/index.html index 3982cde037..d31123fed7 100644 --- a/master/extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/index.html +++ b/master/extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/index.html @@ -17,7 +17,7 @@ - + @@ -942,7 +942,7 @@ - + diff --git a/master/extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/index.html b/master/extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/index.html index 23e147f920..d2a3540e10 100644 --- a/master/extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/index.html +++ b/master/extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/index.html @@ -17,7 +17,7 @@ - + @@ -894,7 +894,7 @@ being rejected with

- + diff --git a/master/extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/index.html b/master/extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/index.html index c8db188841..05e3ebc2a9 100644 --- a/master/extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/index.html +++ b/master/extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/index.html @@ -17,7 +17,7 @@ - + @@ -883,7 +883,7 @@ being rejected with

- + diff --git a/master/extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/index.html b/master/extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/index.html index 4ce2004ad5..bdd6410c30 100644 --- a/master/extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/index.html +++ b/master/extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/index.html @@ -17,7 +17,7 @@ - + @@ -873,7 +873,7 @@ being rejected with

- + diff --git a/master/extensions/api/interfaces/Main.K8sApi.KubeStatusData/index.html b/master/extensions/api/interfaces/Main.K8sApi.KubeStatusData/index.html index 9e7a781fce..81404a24ee 100644 --- a/master/extensions/api/interfaces/Main.K8sApi.KubeStatusData/index.html +++ b/master/extensions/api/interfaces/Main.K8sApi.KubeStatusData/index.html @@ -17,7 +17,7 @@ - + @@ -914,7 +914,7 @@ - + diff --git a/master/extensions/api/interfaces/Main.K8sApi.OwnerReference/index.html b/master/extensions/api/interfaces/Main.K8sApi.OwnerReference/index.html index 4baed4fdaf..dfe623d990 100644 --- a/master/extensions/api/interfaces/Main.K8sApi.OwnerReference/index.html +++ b/master/extensions/api/interfaces/Main.K8sApi.OwnerReference/index.html @@ -17,7 +17,7 @@ - + @@ -914,7 +914,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/index.html b/master/extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/index.html index a7cf38841b..599e78e1ed 100644 --- a/master/extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/index.html @@ -17,7 +17,7 @@ - + @@ -1037,7 +1037,7 @@ elements of the previous index.

- + diff --git a/master/extensions/api/interfaces/Renderer.Component.BadgeProps/index.html b/master/extensions/api/interfaces/Renderer.Component.BadgeProps/index.html index 7213374653..c220eb8b0a 100644 --- a/master/extensions/api/interfaces/Renderer.Component.BadgeProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.BadgeProps/index.html @@ -17,7 +17,7 @@ - + @@ -926,7 +926,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.BarChartProps/index.html b/master/extensions/api/interfaces/Renderer.Component.BarChartProps/index.html index 304963fa44..280b2399c8 100644 --- a/master/extensions/api/interfaces/Renderer.Component.BarChartProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.BarChartProps/index.html @@ -17,7 +17,7 @@ - + @@ -1064,7 +1064,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.BaseIconProps/index.html b/master/extensions/api/interfaces/Renderer.Component.BaseIconProps/index.html index 52de623e8c..98d7442da1 100644 --- a/master/extensions/api/interfaces/Renderer.Component.BaseIconProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.BaseIconProps/index.html @@ -17,7 +17,7 @@ - + @@ -1028,7 +1028,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.ButtonProps/index.html b/master/extensions/api/interfaces/Renderer.Component.ButtonProps/index.html index 4ef521c1fc..a1f1421f28 100644 --- a/master/extensions/api/interfaces/Renderer.Component.ButtonProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.ButtonProps/index.html @@ -17,7 +17,7 @@ - + @@ -1005,7 +1005,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.CheckboxProps/index.html b/master/extensions/api/interfaces/Renderer.Component.CheckboxProps/index.html index a904a9eb22..91a785359d 100644 --- a/master/extensions/api/interfaces/Renderer.Component.CheckboxProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.CheckboxProps/index.html @@ -17,7 +17,7 @@ - + @@ -969,7 +969,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/index.html b/master/extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/index.html index caf9009b03..6da336acbc 100644 --- a/master/extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/index.html @@ -17,7 +17,7 @@ - + @@ -926,7 +926,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/index.html b/master/extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/index.html index 104c9083a0..2f7a1cfcb1 100644 --- a/master/extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/index.html @@ -17,7 +17,7 @@ - + @@ -968,7 +968,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/index.html b/master/extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/index.html index decb7a081c..cc91682ab7 100644 --- a/master/extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/index.html @@ -17,7 +17,7 @@ - + @@ -1019,7 +1019,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/index.html b/master/extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/index.html index 47a3df0c61..e7595f4b6e 100644 --- a/master/extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/index.html @@ -17,7 +17,7 @@ - + @@ -906,7 +906,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.CustomPlaceholderProps/index.html b/master/extensions/api/interfaces/Renderer.Component.CustomPlaceholderProps/index.html index 5841669d56..f864dffe78 100644 --- a/master/extensions/api/interfaces/Renderer.Component.CustomPlaceholderProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.CustomPlaceholderProps/index.html @@ -17,7 +17,7 @@ - + @@ -823,7 +823,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.DialogProps/index.html b/master/extensions/api/interfaces/Renderer.Component.DialogProps/index.html index a439ec240b..2363dad519 100644 --- a/master/extensions/api/interfaces/Renderer.Component.DialogProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.DialogProps/index.html @@ -17,7 +17,7 @@ - + @@ -985,7 +985,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/index.html b/master/extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/index.html index a7bc41ad58..270508a544 100644 --- a/master/extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/index.html @@ -17,7 +17,7 @@ - + @@ -939,7 +939,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.DrawerItemProps/index.html b/master/extensions/api/interfaces/Renderer.Component.DrawerItemProps/index.html index 99f1edd186..7c58afdcdb 100644 --- a/master/extensions/api/interfaces/Renderer.Component.DrawerItemProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.DrawerItemProps/index.html @@ -17,7 +17,7 @@ - + @@ -923,7 +923,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/index.html b/master/extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/index.html index 8d8aee59ca..b7e1cae578 100644 --- a/master/extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/index.html @@ -17,7 +17,7 @@ - + @@ -870,7 +870,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.DrawerProps/index.html b/master/extensions/api/interfaces/Renderer.Component.DrawerProps/index.html index 66c3660fb8..bdcabb3de7 100644 --- a/master/extensions/api/interfaces/Renderer.Component.DrawerProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.DrawerProps/index.html @@ -17,7 +17,7 @@ - + @@ -997,7 +997,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.DrawerTitleProps/index.html b/master/extensions/api/interfaces/Renderer.Component.DrawerTitleProps/index.html index 732beb77c3..a9a32e7f95 100644 --- a/master/extensions/api/interfaces/Renderer.Component.DrawerTitleProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.DrawerTitleProps/index.html @@ -17,7 +17,7 @@ - + @@ -898,7 +898,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.IconDataFnArg/index.html b/master/extensions/api/interfaces/Renderer.Component.IconDataFnArg/index.html index deee5603ba..7af42c5e28 100644 --- a/master/extensions/api/interfaces/Renderer.Component.IconDataFnArg/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.IconDataFnArg/index.html @@ -17,7 +17,7 @@ - + @@ -859,7 +859,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.IconProps/index.html b/master/extensions/api/interfaces/Renderer.Component.IconProps/index.html index 548fe6d469..8ec0330f56 100644 --- a/master/extensions/api/interfaces/Renderer.Component.IconProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.IconProps/index.html @@ -17,7 +17,7 @@ - + @@ -1061,7 +1061,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/index.html b/master/extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/index.html index e57b20e283..21e82b60ac 100644 --- a/master/extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/index.html @@ -17,7 +17,7 @@ - + @@ -859,7 +859,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/index.html b/master/extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/index.html index 7189c8844e..9c17b4f748 100644 --- a/master/extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/index.html @@ -17,7 +17,7 @@ - + @@ -892,7 +892,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/index.html b/master/extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/index.html index 6c497dc4b2..3f6a303b30 100644 --- a/master/extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/index.html @@ -17,7 +17,7 @@ - + @@ -1488,7 +1488,7 @@ If not provided, ResourceNames is used instead with a fallback to resource kind. - + diff --git a/master/extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/index.html b/master/extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/index.html index ac5bdc6a87..4fdcb312a6 100644 --- a/master/extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/index.html @@ -17,7 +17,7 @@ - + @@ -1259,7 +1259,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/index.html b/master/extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/index.html index b6a857a136..21d945e0da 100644 --- a/master/extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/index.html @@ -17,7 +17,7 @@ - + @@ -870,7 +870,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.LineProgressProps/index.html b/master/extensions/api/interfaces/Renderer.Component.LineProgressProps/index.html index 26c1b52f18..692fa8fbec 100644 --- a/master/extensions/api/interfaces/Renderer.Component.LineProgressProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.LineProgressProps/index.html @@ -17,7 +17,7 @@ - + @@ -923,7 +923,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.MainLayoutProps/index.html b/master/extensions/api/interfaces/Renderer.Component.MainLayoutProps/index.html index 9b963ebbe3..ac63189c9b 100644 --- a/master/extensions/api/interfaces/Renderer.Component.MainLayoutProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.MainLayoutProps/index.html @@ -17,7 +17,7 @@ - + @@ -892,7 +892,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.MenuActionsProps/index.html b/master/extensions/api/interfaces/Renderer.Component.MenuActionsProps/index.html index 27e5b1064c..02eef2ebb5 100644 --- a/master/extensions/api/interfaces/Renderer.Component.MenuActionsProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.MenuActionsProps/index.html @@ -17,7 +17,7 @@ - + @@ -1191,7 +1191,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.MenuContextValue/index.html b/master/extensions/api/interfaces/Renderer.Component.MenuContextValue/index.html index 161a95c41f..e1e127ed4b 100644 --- a/master/extensions/api/interfaces/Renderer.Component.MenuContextValue/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.MenuContextValue/index.html @@ -17,7 +17,7 @@ - + @@ -874,7 +874,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.MenuItemProps/index.html b/master/extensions/api/interfaces/Renderer.Component.MenuItemProps/index.html index 0701d8c0d8..fc99d8616f 100644 --- a/master/extensions/api/interfaces/Renderer.Component.MenuItemProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.MenuItemProps/index.html @@ -17,7 +17,7 @@ - + @@ -919,7 +919,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.MenuPosition/index.html b/master/extensions/api/interfaces/Renderer.Component.MenuPosition/index.html index bb0db55c94..ff9d9fda38 100644 --- a/master/extensions/api/interfaces/Renderer.Component.MenuPosition/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.MenuPosition/index.html @@ -17,7 +17,7 @@ - + @@ -892,7 +892,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.MenuProps/index.html b/master/extensions/api/interfaces/Renderer.Component.MenuProps/index.html index 4147c16cb1..20e018985c 100644 --- a/master/extensions/api/interfaces/Renderer.Component.MenuProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.MenuProps/index.html @@ -17,7 +17,7 @@ - + @@ -1051,7 +1051,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.MenuStyle/index.html b/master/extensions/api/interfaces/Renderer.Component.MenuStyle/index.html index 5c4c0d45fe..2fa75342a8 100644 --- a/master/extensions/api/interfaces/Renderer.Component.MenuStyle/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.MenuStyle/index.html @@ -17,7 +17,7 @@ - + @@ -870,7 +870,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.MonacoEditorProps/index.html b/master/extensions/api/interfaces/Renderer.Component.MonacoEditorProps/index.html index 897ca624c6..194616949c 100644 --- a/master/extensions/api/interfaces/Renderer.Component.MonacoEditorProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.MonacoEditorProps/index.html @@ -17,7 +17,7 @@ - + @@ -1140,7 +1140,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/index.html b/master/extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/index.html index 0d92daf486..f88bb43287 100644 --- a/master/extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/index.html @@ -17,7 +17,7 @@ - + @@ -984,7 +984,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.Notification/index.html b/master/extensions/api/interfaces/Renderer.Component.Notification/index.html index d3555e7dbb..667a2c684e 100644 --- a/master/extensions/api/interfaces/Renderer.Component.Notification/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.Notification/index.html @@ -17,7 +17,7 @@ - + @@ -928,7 +928,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.PieChartData/index.html b/master/extensions/api/interfaces/Renderer.Component.PieChartData/index.html index 9b6798869b..f4835fb033 100644 --- a/master/extensions/api/interfaces/Renderer.Component.PieChartData/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.PieChartData/index.html @@ -17,7 +17,7 @@ - + @@ -873,7 +873,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.PieChartProps/index.html b/master/extensions/api/interfaces/Renderer.Component.PieChartProps/index.html index f520aa1720..357788b4fb 100644 --- a/master/extensions/api/interfaces/Renderer.Component.PieChartProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.PieChartProps/index.html @@ -17,7 +17,7 @@ - + @@ -1042,7 +1042,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.PodDetailsListProps/index.html b/master/extensions/api/interfaces/Renderer.Component.PodDetailsListProps/index.html index 34811c0c4f..fe30ba30f6 100644 --- a/master/extensions/api/interfaces/Renderer.Component.PodDetailsListProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.PodDetailsListProps/index.html @@ -17,7 +17,7 @@ - + @@ -892,7 +892,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.RadioGroupProps/index.html b/master/extensions/api/interfaces/Renderer.Component.RadioGroupProps/index.html index 134ab3df0c..b17e87197e 100644 --- a/master/extensions/api/interfaces/Renderer.Component.RadioGroupProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.RadioGroupProps/index.html @@ -17,7 +17,7 @@ - + @@ -953,7 +953,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.RadioProps/index.html b/master/extensions/api/interfaces/Renderer.Component.RadioProps/index.html index 8911e6501a..2de4c9e76a 100644 --- a/master/extensions/api/interfaces/Renderer.Component.RadioProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.RadioProps/index.html @@ -17,7 +17,7 @@ - + @@ -912,7 +912,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/index.html b/master/extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/index.html index 6af16a01f9..e7eb9ec781 100644 --- a/master/extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/index.html @@ -17,7 +17,7 @@ - + @@ -925,7 +925,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.ResourceMetricsValue/index.html b/master/extensions/api/interfaces/Renderer.Component.ResourceMetricsValue/index.html index 59d21e42dd..81fb409fa4 100644 --- a/master/extensions/api/interfaces/Renderer.Component.ResourceMetricsValue/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.ResourceMetricsValue/index.html @@ -17,7 +17,7 @@ - + @@ -881,7 +881,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.SearchInputProps/index.html b/master/extensions/api/interfaces/Renderer.Component.SearchInputProps/index.html index 3488359b01..169e3cd332 100644 --- a/master/extensions/api/interfaces/Renderer.Component.SearchInputProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.SearchInputProps/index.html @@ -17,7 +17,7 @@ - + @@ -1166,7 +1166,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.SelectOption/index.html b/master/extensions/api/interfaces/Renderer.Component.SelectOption/index.html index 059a84dc4a..c62bbcb4b1 100644 --- a/master/extensions/api/interfaces/Renderer.Component.SelectOption/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.SelectOption/index.html @@ -17,7 +17,7 @@ - + @@ -923,7 +923,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.SelectProps/index.html b/master/extensions/api/interfaces/Renderer.Component.SelectProps/index.html index 1e006c6a21..6bf9008c9a 100644 --- a/master/extensions/api/interfaces/Renderer.Component.SelectProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.SelectProps/index.html @@ -17,7 +17,7 @@ - + @@ -977,7 +977,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.SettingLayoutProps/index.html b/master/extensions/api/interfaces/Renderer.Component.SettingLayoutProps/index.html index e707d7ce6d..37e20dbae5 100644 --- a/master/extensions/api/interfaces/Renderer.Component.SettingLayoutProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.SettingLayoutProps/index.html @@ -17,7 +17,7 @@ - + @@ -971,7 +971,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.SliderProps/index.html b/master/extensions/api/interfaces/Renderer.Component.SliderProps/index.html index 9f0951f0b3..85bc69b1ac 100644 --- a/master/extensions/api/interfaces/Renderer.Component.SliderProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.SliderProps/index.html @@ -17,7 +17,7 @@ - + @@ -928,7 +928,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.SpinnerProps/index.html b/master/extensions/api/interfaces/Renderer.Component.SpinnerProps/index.html index f5b91cdfcc..2e3bd0bc9d 100644 --- a/master/extensions/api/interfaces/Renderer.Component.SpinnerProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.SpinnerProps/index.html @@ -17,7 +17,7 @@ - + @@ -882,7 +882,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.StatusBrickProps/index.html b/master/extensions/api/interfaces/Renderer.Component.StatusBrickProps/index.html index dbd85f1175..f4833b00c1 100644 --- a/master/extensions/api/interfaces/Renderer.Component.StatusBrickProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.StatusBrickProps/index.html @@ -17,7 +17,7 @@ - + @@ -823,7 +823,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.StepperProps/index.html b/master/extensions/api/interfaces/Renderer.Component.StepperProps/index.html index c59af2b353..f92a0599c3 100644 --- a/master/extensions/api/interfaces/Renderer.Component.StepperProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.StepperProps/index.html @@ -17,7 +17,7 @@ - + @@ -884,7 +884,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.SubTitleProps/index.html b/master/extensions/api/interfaces/Renderer.Component.SubTitleProps/index.html index 475b809f1f..61b9e444b2 100644 --- a/master/extensions/api/interfaces/Renderer.Component.SubTitleProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.SubTitleProps/index.html @@ -17,7 +17,7 @@ - + @@ -903,7 +903,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.SwitchProps/index.html b/master/extensions/api/interfaces/Renderer.Component.SwitchProps/index.html index f156257dab..b3546c8ebc 100644 --- a/master/extensions/api/interfaces/Renderer.Component.SwitchProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.SwitchProps/index.html @@ -17,7 +17,7 @@ - + @@ -894,7 +894,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.SwitcherProps/index.html b/master/extensions/api/interfaces/Renderer.Component.SwitcherProps/index.html index bad121ed88..cd438f926d 100644 --- a/master/extensions/api/interfaces/Renderer.Component.SwitcherProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.SwitcherProps/index.html @@ -17,7 +17,7 @@ - + @@ -926,7 +926,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.TabLayoutProps/index.html b/master/extensions/api/interfaces/Renderer.Component.TabLayoutProps/index.html index 0ce03939e7..34298565a6 100644 --- a/master/extensions/api/interfaces/Renderer.Component.TabLayoutProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.TabLayoutProps/index.html @@ -17,7 +17,7 @@ - + @@ -903,7 +903,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.TabLayoutRoute/index.html b/master/extensions/api/interfaces/Renderer.Component.TabLayoutRoute/index.html index 01c8f84ea1..36460680c0 100644 --- a/master/extensions/api/interfaces/Renderer.Component.TabLayoutRoute/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.TabLayoutRoute/index.html @@ -17,7 +17,7 @@ - + @@ -914,7 +914,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.TabProps/index.html b/master/extensions/api/interfaces/Renderer.Component.TabProps/index.html index 3d4a3a62a6..15bb58f26f 100644 --- a/master/extensions/api/interfaces/Renderer.Component.TabProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.TabProps/index.html @@ -17,7 +17,7 @@ - + @@ -957,7 +957,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.TableCellProps/index.html b/master/extensions/api/interfaces/Renderer.Component.TableCellProps/index.html index 82e1d2dcca..6fef5b7339 100644 --- a/master/extensions/api/interfaces/Renderer.Component.TableCellProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.TableCellProps/index.html @@ -17,7 +17,7 @@ - + @@ -1042,7 +1042,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.TableHeadProps/index.html b/master/extensions/api/interfaces/Renderer.Component.TableHeadProps/index.html index b4f6467033..86516eb8b5 100644 --- a/master/extensions/api/interfaces/Renderer.Component.TableHeadProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.TableHeadProps/index.html @@ -17,7 +17,7 @@ - + @@ -915,7 +915,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.TableProps/index.html b/master/extensions/api/interfaces/Renderer.Component.TableProps/index.html index 1244a5e280..71a2eae269 100644 --- a/master/extensions/api/interfaces/Renderer.Component.TableProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.TableProps/index.html @@ -17,7 +17,7 @@ - + @@ -1208,7 +1208,7 @@ is overflow-y: scroll,

- + diff --git a/master/extensions/api/interfaces/Renderer.Component.TableRowProps/index.html b/master/extensions/api/interfaces/Renderer.Component.TableRowProps/index.html index 3457131a9a..a54d8a7d50 100644 --- a/master/extensions/api/interfaces/Renderer.Component.TableRowProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.TableRowProps/index.html @@ -17,7 +17,7 @@ - + @@ -972,7 +972,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.TableSortParams/index.html b/master/extensions/api/interfaces/Renderer.Component.TableSortParams/index.html index bf4c543153..e587f43649 100644 --- a/master/extensions/api/interfaces/Renderer.Component.TableSortParams/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.TableSortParams/index.html @@ -17,7 +17,7 @@ - + @@ -870,7 +870,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.TabsProps/index.html b/master/extensions/api/interfaces/Renderer.Component.TabsProps/index.html index f4783f1c8d..8d39a70ef5 100644 --- a/master/extensions/api/interfaces/Renderer.Component.TabsProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.TabsProps/index.html @@ -17,7 +17,7 @@ - + @@ -1021,7 +1021,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/index.html b/master/extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/index.html index 40e40f8172..64e2d7a092 100644 --- a/master/extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/index.html @@ -17,7 +17,7 @@ - + @@ -903,7 +903,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/index.html b/master/extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/index.html index b24fb5af14..7849955d68 100644 --- a/master/extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/index.html @@ -17,7 +17,7 @@ - + @@ -894,7 +894,7 @@ useful for displaying tooltips even when the target is "disabled"

- + diff --git a/master/extensions/api/interfaces/Renderer.Component.TooltipProps/index.html b/master/extensions/api/interfaces/Renderer.Component.TooltipProps/index.html index 1ff8e75ee4..93ab8eaa11 100644 --- a/master/extensions/api/interfaces/Renderer.Component.TooltipProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.TooltipProps/index.html @@ -17,7 +17,7 @@ - + @@ -969,7 +969,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.WizardCommonProps/index.html b/master/extensions/api/interfaces/Renderer.Component.WizardCommonProps/index.html index 9ba92a089c..57957a5d9b 100644 --- a/master/extensions/api/interfaces/Renderer.Component.WizardCommonProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.WizardCommonProps/index.html @@ -17,7 +17,7 @@ - + @@ -967,7 +967,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.WizardLayoutProps/index.html b/master/extensions/api/interfaces/Renderer.Component.WizardLayoutProps/index.html index e1ca24321e..34e3a0ee09 100644 --- a/master/extensions/api/interfaces/Renderer.Component.WizardLayoutProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.WizardLayoutProps/index.html @@ -17,7 +17,7 @@ - + @@ -937,7 +937,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.WizardProps/index.html b/master/extensions/api/interfaces/Renderer.Component.WizardProps/index.html index 7342f7ae86..02476de65b 100644 --- a/master/extensions/api/interfaces/Renderer.Component.WizardProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.WizardProps/index.html @@ -17,7 +17,7 @@ - + @@ -1061,7 +1061,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Component.WizardStepProps/index.html b/master/extensions/api/interfaces/Renderer.Component.WizardStepProps/index.html index ad9d5acf0c..c49cc40e2e 100644 --- a/master/extensions/api/interfaces/Renderer.Component.WizardStepProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.WizardStepProps/index.html @@ -17,7 +17,7 @@ - + @@ -1308,7 +1308,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/index.html b/master/extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/index.html index f614352bcf..40fe0ae6ed 100644 --- a/master/extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/index.html +++ b/master/extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/index.html @@ -17,7 +17,7 @@ - + @@ -883,7 +883,7 @@ Licensed under MIT License. See LICENSE in root directory for more information.< - + diff --git a/master/extensions/api/interfaces/Renderer.K8sApi.MetricData/index.html b/master/extensions/api/interfaces/Renderer.K8sApi.MetricData/index.html index 8de66adf95..980213a161 100644 --- a/master/extensions/api/interfaces/Renderer.K8sApi.MetricData/index.html +++ b/master/extensions/api/interfaces/Renderer.K8sApi.MetricData/index.html @@ -17,7 +17,7 @@ - + @@ -891,7 +891,7 @@ Licensed under MIT License. See LICENSE in root directory for more information.< - + diff --git a/master/extensions/api/interfaces/Renderer.K8sApi.MetricResult/index.html b/master/extensions/api/interfaces/Renderer.K8sApi.MetricResult/index.html index 9207352b19..c14161c1df 100644 --- a/master/extensions/api/interfaces/Renderer.K8sApi.MetricResult/index.html +++ b/master/extensions/api/interfaces/Renderer.K8sApi.MetricResult/index.html @@ -17,7 +17,7 @@ - + @@ -907,7 +907,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/index.html b/master/extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/index.html index b47d373c1d..fc421ec842 100644 --- a/master/extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/index.html +++ b/master/extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/index.html @@ -17,7 +17,7 @@ - + @@ -914,7 +914,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Navigation.PageParamInit/index.html b/master/extensions/api/interfaces/Renderer.Navigation.PageParamInit/index.html index 66f3235409..e0df27d4d0 100644 --- a/master/extensions/api/interfaces/Renderer.Navigation.PageParamInit/index.html +++ b/master/extensions/api/interfaces/Renderer.Navigation.PageParamInit/index.html @@ -17,7 +17,7 @@ - + @@ -971,7 +971,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Navigation.URLParams/index.html b/master/extensions/api/interfaces/Renderer.Navigation.URLParams/index.html index 3d84ddb069..86b0b6a1a2 100644 --- a/master/extensions/api/interfaces/Renderer.Navigation.URLParams/index.html +++ b/master/extensions/api/interfaces/Renderer.Navigation.URLParams/index.html @@ -17,7 +17,7 @@ - + @@ -907,7 +907,7 @@ - + diff --git a/master/extensions/api/interfaces/Renderer.Theme.LensTheme/index.html b/master/extensions/api/interfaces/Renderer.Theme.LensTheme/index.html index 15217a5ea7..e8f7a00b75 100644 --- a/master/extensions/api/interfaces/Renderer.Theme.LensTheme/index.html +++ b/master/extensions/api/interfaces/Renderer.Theme.LensTheme/index.html @@ -17,7 +17,7 @@ - + @@ -936,7 +936,7 @@ - + diff --git a/master/extensions/api/modules/Common.Catalog/index.html b/master/extensions/api/modules/Common.Catalog/index.html index 970d12d4cf..84b64dcc09 100644 --- a/master/extensions/api/modules/Common.Catalog/index.html +++ b/master/extensions/api/modules/Common.Catalog/index.html @@ -17,7 +17,7 @@ - + @@ -1194,7 +1194,7 @@ - + diff --git a/master/extensions/api/modules/Common.EventBus/index.html b/master/extensions/api/modules/Common.EventBus/index.html index be5dd0c885..5ff05cdbfc 100644 --- a/master/extensions/api/modules/Common.EventBus/index.html +++ b/master/extensions/api/modules/Common.EventBus/index.html @@ -17,7 +17,7 @@ - + @@ -950,7 +950,7 @@ - + diff --git a/master/extensions/api/modules/Common.Proxy/index.html b/master/extensions/api/modules/Common.Proxy/index.html index 285bc86258..06057fe42a 100644 --- a/master/extensions/api/modules/Common.Proxy/index.html +++ b/master/extensions/api/modules/Common.Proxy/index.html @@ -17,7 +17,7 @@ - + @@ -880,7 +880,7 @@ - + diff --git a/master/extensions/api/modules/Common.Store/index.html b/master/extensions/api/modules/Common.Store/index.html index 53178366cd..338d6da34c 100644 --- a/master/extensions/api/modules/Common.Store/index.html +++ b/master/extensions/api/modules/Common.Store/index.html @@ -17,7 +17,7 @@ - + @@ -848,7 +848,7 @@ - + diff --git a/master/extensions/api/modules/Common.Types/index.html b/master/extensions/api/modules/Common.Types/index.html index 35b3a30209..74083fbb36 100644 --- a/master/extensions/api/modules/Common.Types/index.html +++ b/master/extensions/api/modules/Common.Types/index.html @@ -17,7 +17,7 @@ - + @@ -1006,7 +1006,7 @@ Licensed under MIT License. See LICENSE in root directory for more information.< - + diff --git a/master/extensions/api/modules/Common.Util/index.html b/master/extensions/api/modules/Common.Util/index.html index 26262588b7..ffcf94ddfd 100644 --- a/master/extensions/api/modules/Common.Util/index.html +++ b/master/extensions/api/modules/Common.Util/index.html @@ -17,7 +17,7 @@ - + @@ -1167,7 +1167,7 @@ Licensed under MIT License. See LICENSE in root directory for more information.< - + diff --git a/master/extensions/api/modules/Common/index.html b/master/extensions/api/modules/Common/index.html index 4b03b5fb51..2fd102bc67 100644 --- a/master/extensions/api/modules/Common/index.html +++ b/master/extensions/api/modules/Common/index.html @@ -17,7 +17,7 @@ - + @@ -1018,7 +1018,7 @@ Licensed under MIT License. See LICENSE in root directory for more information.< - + diff --git a/master/extensions/api/modules/Main.Catalog/index.html b/master/extensions/api/modules/Main.Catalog/index.html index e977e03892..2056bd891e 100644 --- a/master/extensions/api/modules/Main.Catalog/index.html +++ b/master/extensions/api/modules/Main.Catalog/index.html @@ -17,7 +17,7 @@ - + @@ -883,7 +883,7 @@ Licensed under MIT License. See LICENSE in root directory for more information.< - + diff --git a/master/extensions/api/modules/Main.K8sApi/index.html b/master/extensions/api/modules/Main.K8sApi/index.html index 5fca2cffd5..c00ae497de 100644 --- a/master/extensions/api/modules/Main.K8sApi/index.html +++ b/master/extensions/api/modules/Main.K8sApi/index.html @@ -17,7 +17,7 @@ - + @@ -1829,7 +1829,7 @@ - + diff --git a/master/extensions/api/modules/Main.Navigation/index.html b/master/extensions/api/modules/Main.Navigation/index.html index e9a130cc57..8c91fff3ab 100644 --- a/master/extensions/api/modules/Main.Navigation/index.html +++ b/master/extensions/api/modules/Main.Navigation/index.html @@ -17,7 +17,7 @@ - + @@ -878,7 +878,7 @@ Licensed under MIT License. See LICENSE in root directory for more information.< - + diff --git a/master/extensions/api/modules/Main.Power/index.html b/master/extensions/api/modules/Main.Power/index.html index a6efbbbc5a..2fabb4e8f8 100644 --- a/master/extensions/api/modules/Main.Power/index.html +++ b/master/extensions/api/modules/Main.Power/index.html @@ -17,7 +17,7 @@ - + @@ -984,7 +984,7 @@ the system is about to reboot or shut down

- + diff --git a/master/extensions/api/modules/Main/index.html b/master/extensions/api/modules/Main/index.html index a62f75763a..c8925b6467 100644 --- a/master/extensions/api/modules/Main/index.html +++ b/master/extensions/api/modules/Main/index.html @@ -17,7 +17,7 @@ - + @@ -852,7 +852,7 @@ Licensed under MIT License. See LICENSE in root directory for more information.< - + diff --git a/master/extensions/api/modules/Renderer.Catalog/index.html b/master/extensions/api/modules/Renderer.Catalog/index.html index a4d7cd48a7..dcf613552d 100644 --- a/master/extensions/api/modules/Renderer.Catalog/index.html +++ b/master/extensions/api/modules/Renderer.Catalog/index.html @@ -17,7 +17,7 @@ - + @@ -892,7 +892,7 @@ - + diff --git a/master/extensions/api/modules/Renderer.Component/index.html b/master/extensions/api/modules/Renderer.Component/index.html index 01120a2c06..2bdf719951 100644 --- a/master/extensions/api/modules/Renderer.Component/index.html +++ b/master/extensions/api/modules/Renderer.Component/index.html @@ -17,7 +17,7 @@ - + @@ -2168,7 +2168,7 @@

null | ReactElement<any, any>


Checkbox#

-

Checkbox(«destructured»): JSX.Element

+

Checkbox(«destructured»): React.JSX.Element

Parameters#

@@ -2185,7 +2185,7 @@

Returns#

-

JSX.Element

+

React.JSX.Element


ConfirmDialog#

ConfirmDialog(props, context?): null | ReactElement<any, any>

@@ -2260,7 +2260,7 @@

null | ReactElement<any, any>


DrawerItem#

-

DrawerItem(«destructured»): JSX.Element | null

+

DrawerItem(«destructured»): React.JSX.Element | null

Parameters#

@@ -2277,10 +2277,10 @@

Returns#

-

JSX.Element | null

+

React.JSX.Element | null


DrawerItemLabels#

-

DrawerItemLabels(props): JSX.Element | null

+

DrawerItemLabels(props): React.JSX.Element | null

Parameters#

@@ -2297,10 +2297,10 @@

Returns#

-

JSX.Element | null

+

React.JSX.Element | null


DrawerTitle#

-

DrawerTitle(«destructured»): JSX.Element

+

DrawerTitle(«destructured»): React.JSX.Element

Parameters#

@@ -2317,7 +2317,7 @@

Returns#

-

JSX.Element

+

React.JSX.Element


FormSwitch#

FormSwitch(props): React.FunctionComponentElement<any>

@@ -2745,7 +2745,7 @@

null | ReactElement<any, any>


Radio#

-

Radio<T>(«destructured»): JSX.Element

+

Radio<T>(«destructured»): React.JSX.Element

Type parameters#

@@ -2775,10 +2775,10 @@

Returns#

-

JSX.Element

+

React.JSX.Element


RadioGroup#

-

RadioGroup<T>(«destructured»): JSX.Element

+

RadioGroup<T>(«destructured»): React.JSX.Element

Type parameters#

@@ -2808,7 +2808,7 @@

Returns#

-

JSX.Element

+

React.JSX.Element


ResourceMetrics#

ResourceMetrics<Keys>(«destructured»): Element

@@ -2941,7 +2941,7 @@

null | ReactElement<any, any>


-

SubMenu(props): JSX.Element

+

SubMenu(props): React.JSX.Element

Parameters#

@@ -2958,10 +2958,10 @@

Returns#

-

JSX.Element

+

React.JSX.Element


Switch#

-

Switch(«destructured»): JSX.Element

+

Switch(«destructured»): React.JSX.Element

Parameters#

@@ -2978,10 +2978,10 @@

Returns#

-

JSX.Element

+

React.JSX.Element


Switcher#

-

Switcher(«destructured»): JSX.Element

+

Switcher(«destructured»): React.JSX.Element

Deprecated

Use instead from "../switch.tsx".

Parameters#

@@ -3000,7 +3000,7 @@

Returns#

-

JSX.Element

+

React.JSX.Element


TabLayout#

TabLayout(props, context?): null | ReactElement<any, any>

@@ -3403,7 +3403,7 @@ valid if one of the input validators matches the input

- + diff --git a/master/extensions/api/modules/Renderer.K8sApi/index.html b/master/extensions/api/modules/Renderer.K8sApi/index.html index 3fbf323f16..a3e67aeb0a 100644 --- a/master/extensions/api/modules/Renderer.K8sApi/index.html +++ b/master/extensions/api/modules/Renderer.K8sApi/index.html @@ -17,7 +17,7 @@ - + @@ -2312,7 +2312,7 @@ - + diff --git a/master/extensions/api/modules/Renderer.Navigation/index.html b/master/extensions/api/modules/Renderer.Navigation/index.html index d36463e5bb..f1e181fecd 100644 --- a/master/extensions/api/modules/Renderer.Navigation/index.html +++ b/master/extensions/api/modules/Renderer.Navigation/index.html @@ -17,7 +17,7 @@ - + @@ -1098,7 +1098,7 @@ - + diff --git a/master/extensions/api/modules/Renderer.Theme/index.html b/master/extensions/api/modules/Renderer.Theme/index.html index 1fb021ee18..aa221f9fe9 100644 --- a/master/extensions/api/modules/Renderer.Theme/index.html +++ b/master/extensions/api/modules/Renderer.Theme/index.html @@ -17,7 +17,7 @@ - + @@ -908,7 +908,7 @@ - + diff --git a/master/extensions/api/modules/Renderer/index.html b/master/extensions/api/modules/Renderer/index.html index dfcf14fbde..4f5eea5c5a 100644 --- a/master/extensions/api/modules/Renderer/index.html +++ b/master/extensions/api/modules/Renderer/index.html @@ -17,7 +17,7 @@ - + @@ -851,7 +851,7 @@ - + diff --git a/master/extensions/api/modules/index.html b/master/extensions/api/modules/index.html index 266905d8cf..0048c82095 100644 --- a/master/extensions/api/modules/index.html +++ b/master/extensions/api/modules/index.html @@ -17,7 +17,7 @@ - + @@ -837,7 +837,7 @@ - + diff --git a/master/extensions/capabilities/common-capabilities/index.html b/master/extensions/capabilities/common-capabilities/index.html index e38755d04d..f4df699d98 100644 --- a/master/extensions/capabilities/common-capabilities/index.html +++ b/master/extensions/capabilities/common-capabilities/index.html @@ -21,7 +21,7 @@ - + @@ -1356,7 +1356,7 @@ These pages are visible in a cluster menu when a cluster is opened.

- + diff --git a/master/extensions/capabilities/index.html b/master/extensions/capabilities/index.html index 7669116a62..40a222bf09 100644 --- a/master/extensions/capabilities/index.html +++ b/master/extensions/capabilities/index.html @@ -17,7 +17,7 @@ - + @@ -796,7 +796,7 @@ - + diff --git a/master/extensions/capabilities/styling/index.html b/master/extensions/capabilities/styling/index.html index c6fd64dcc6..7b280ca64c 100644 --- a/master/extensions/capabilities/styling/index.html +++ b/master/extensions/capabilities/styling/index.html @@ -21,7 +21,7 @@ - + @@ -1103,7 +1103,7 @@ If the class isn't there, the theme defaults to dark. The active theme can be ch - + diff --git a/master/extensions/extension-migration/index.html b/master/extensions/extension-migration/index.html index 52bcb37f80..aeb62f1861 100644 --- a/master/extensions/extension-migration/index.html +++ b/master/extensions/extension-migration/index.html @@ -17,7 +17,7 @@ - + @@ -823,7 +823,7 @@ See Migrating from Mobx - + diff --git a/master/extensions/get-started/anatomy/index.html b/master/extensions/get-started/anatomy/index.html index da2a77264a..d11b05c8bc 100644 --- a/master/extensions/get-started/anatomy/index.html +++ b/master/extensions/get-started/anatomy/index.html @@ -21,7 +21,7 @@ - + @@ -1093,7 +1093,7 @@ The Common Capabilities pa - + diff --git a/master/extensions/get-started/overview/index.html b/master/extensions/get-started/overview/index.html index 11066efa3b..5bb80fe422 100644 --- a/master/extensions/get-started/overview/index.html +++ b/master/extensions/get-started/overview/index.html @@ -21,7 +21,7 @@ - + @@ -898,7 +898,7 @@ If an extension's main part starts new processes they all must be stopped and cl - + diff --git a/master/extensions/get-started/wrapping-up/index.html b/master/extensions/get-started/wrapping-up/index.html index f0ec915740..dd9a6709c6 100644 --- a/master/extensions/get-started/wrapping-up/index.html +++ b/master/extensions/get-started/wrapping-up/index.html @@ -21,7 +21,7 @@ - + @@ -908,7 +908,7 @@ You can find all samples and guides in the {"base": "../../..", "features": ["toc.autohide", "search.suggest", "search.highlight", "content.code.copy"], "search": "../../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}} - + diff --git a/master/extensions/get-started/your-first-extension/index.html b/master/extensions/get-started/your-first-extension/index.html index 22362fd4b6..25cfa265ce 100644 --- a/master/extensions/get-started/your-first-extension/index.html +++ b/master/extensions/get-started/your-first-extension/index.html @@ -21,7 +21,7 @@ - + @@ -1020,7 +1020,7 @@ You will see the "Hello World" page in the left-side cluster menu.

- + diff --git a/master/extensions/guides/anatomy/index.html b/master/extensions/guides/anatomy/index.html index 5efff9c0f0..79ab04d6e1 100644 --- a/master/extensions/guides/anatomy/index.html +++ b/master/extensions/guides/anatomy/index.html @@ -17,7 +17,7 @@ - + @@ -817,7 +817,7 @@ - + diff --git a/master/extensions/guides/catalog/index.html b/master/extensions/guides/catalog/index.html index be244f4b37..cf56148b5e 100644 --- a/master/extensions/guides/catalog/index.html +++ b/master/extensions/guides/catalog/index.html @@ -21,7 +21,7 @@ - + @@ -956,7 +956,7 @@ All entities are typed and the class instances will be recreated on the renderer - + diff --git a/master/extensions/guides/components/index.html b/master/extensions/guides/components/index.html index 5eb82db92b..3af633e631 100644 --- a/master/extensions/guides/components/index.html +++ b/master/extensions/guides/components/index.html @@ -17,7 +17,7 @@ - + @@ -817,7 +817,7 @@ - + diff --git a/master/extensions/guides/extending-kubernetes-cluster/index.html b/master/extensions/guides/extending-kubernetes-cluster/index.html index b6565b6e38..a125cc51a4 100644 --- a/master/extensions/guides/extending-kubernetes-cluster/index.html +++ b/master/extensions/guides/extending-kubernetes-cluster/index.html @@ -21,7 +21,7 @@ - + @@ -929,7 +929,7 @@ - + diff --git a/master/extensions/guides/generator/index.html b/master/extensions/guides/generator/index.html index dd8c154f09..2f24eadaf2 100644 --- a/master/extensions/guides/generator/index.html +++ b/master/extensions/guides/generator/index.html @@ -21,7 +21,7 @@ - + @@ -952,7 +952,7 @@ You can find the latest Lens contribution guidelines
{"base": "../../..", "features": ["toc.autohide", "search.suggest", "search.highlight", "content.code.copy"], "search": "../../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}} - + diff --git a/master/extensions/guides/index.html b/master/extensions/guides/index.html index 36beb53918..bc6c936d6c 100644 --- a/master/extensions/guides/index.html +++ b/master/extensions/guides/index.html @@ -21,7 +21,7 @@ - + @@ -978,7 +978,7 @@ For introductory information about the Lens Extension API, please see {"base": "../..", "features": ["toc.autohide", "search.suggest", "search.highlight", "content.code.copy"], "search": "../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}} - + diff --git a/master/extensions/guides/ipc/index.html b/master/extensions/guides/ipc/index.html index 95c2cf4068..6ccaee8527 100644 --- a/master/extensions/guides/ipc/index.html +++ b/master/extensions/guides/ipc/index.html @@ -21,7 +21,7 @@ - + @@ -1052,7 +1052,7 @@ This means that more types than what are JSON serializable can be used, but not - + diff --git a/master/extensions/guides/kube-object-list-layout/index.html b/master/extensions/guides/kube-object-list-layout/index.html index 5fc5797036..7de710ba13 100644 --- a/master/extensions/guides/kube-object-list-layout/index.html +++ b/master/extensions/guides/kube-object-list-layout/index.html @@ -17,7 +17,7 @@ - + @@ -1134,7 +1134,7 @@ Please see the {"base": "../../..", "features": ["toc.autohide", "search.suggest", "search.highlight", "content.code.copy"], "search": "../../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}} - + diff --git a/master/extensions/guides/main-extension/index.html b/master/extensions/guides/main-extension/index.html index c1e1626f0d..4b1dbb7123 100644 --- a/master/extensions/guides/main-extension/index.html +++ b/master/extensions/guides/main-extension/index.html @@ -21,7 +21,7 @@ - + @@ -1038,7 +1038,7 @@ See the Catalog documentation for full de - + diff --git a/master/extensions/guides/protocol-handlers/index.html b/master/extensions/guides/protocol-handlers/index.html index 2b8a8f8ac3..688a52ccd9 100644 --- a/master/extensions/guides/protocol-handlers/index.html +++ b/master/extensions/guides/protocol-handlers/index.html @@ -21,7 +21,7 @@ - + @@ -952,7 +952,7 @@ This way the "/" (root) pathSchema acts as a sort of c - + diff --git a/master/extensions/guides/renderer-extension/index.html b/master/extensions/guides/renderer-extension/index.html index 55920f88dd..4742b4e898 100644 --- a/master/extensions/guides/renderer-extension/index.html +++ b/master/extensions/guides/renderer-extension/index.html @@ -21,7 +21,7 @@ - + @@ -1786,7 +1786,7 @@ See {"base": "../../..", "features": ["toc.autohide", "search.suggest", "search.highlight", "content.code.copy"], "search": "../../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}} - + diff --git a/master/extensions/guides/resource-stack/index.html b/master/extensions/guides/resource-stack/index.html index e3e61f1056..00d741af9c 100644 --- a/master/extensions/guides/resource-stack/index.html +++ b/master/extensions/guides/resource-stack/index.html @@ -21,7 +21,7 @@ - + @@ -1029,7 +1029,7 @@ The Lens Metrics setting (on the cluster Settings{"base": "../../..", "features": ["toc.autohide", "search.suggest", "search.highlight", "content.code.copy"], "search": "../../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}} - + diff --git a/master/extensions/guides/stores/index.html b/master/extensions/guides/stores/index.html index 745221e973..1fc963a080 100644 --- a/master/extensions/guides/stores/index.html +++ b/master/extensions/guides/stores/index.html @@ -21,7 +21,7 @@ - + @@ -1009,7 +1009,7 @@ Everything else works as before, except that now the enabled state - + diff --git a/master/extensions/guides/working-with-mobx/index.html b/master/extensions/guides/working-with-mobx/index.html index 594e58dc92..9d2f671616 100644 --- a/master/extensions/guides/working-with-mobx/index.html +++ b/master/extensions/guides/working-with-mobx/index.html @@ -21,7 +21,7 @@ - + @@ -897,7 +897,7 @@ The result is a more declarative state management style, rather than React's nat - + diff --git a/master/extensions/testing-and-publishing/bundling/index.html b/master/extensions/testing-and-publishing/bundling/index.html index d67f8939ff..3ebab8df6d 100644 --- a/master/extensions/testing-and-publishing/bundling/index.html +++ b/master/extensions/testing-and-publishing/bundling/index.html @@ -17,7 +17,7 @@ - + @@ -796,7 +796,7 @@ - + diff --git a/master/extensions/testing-and-publishing/publishing/index.html b/master/extensions/testing-and-publishing/publishing/index.html index 706a0165ea..5a3591b26f 100644 --- a/master/extensions/testing-and-publishing/publishing/index.html +++ b/master/extensions/testing-and-publishing/publishing/index.html @@ -21,7 +21,7 @@ - + @@ -946,7 +946,7 @@ The following will be a quick walk through on how to make the tarball which will - + diff --git a/master/extensions/testing-and-publishing/testing/index.html b/master/extensions/testing-and-publishing/testing/index.html index a1e10c196c..6036e41fbf 100644 --- a/master/extensions/testing-and-publishing/testing/index.html +++ b/master/extensions/testing-and-publishing/testing/index.html @@ -21,7 +21,7 @@ - + @@ -1011,7 +1011,7 @@ tail -f /proc/[{"base": "../../..", "features": ["toc.autohide", "search.suggest", "search.highlight", "content.code.copy"], "search": "../../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}} - + diff --git a/master/extensions/usage/index.html b/master/extensions/usage/index.html index 841aba0a78..95c10df96c 100644 --- a/master/extensions/usage/index.html +++ b/master/extensions/usage/index.html @@ -17,7 +17,7 @@ - + @@ -847,7 +847,7 @@ A disabled extension is not loaded by Lens and is not run.

- + diff --git a/master/index.html b/master/index.html index 003e470b7f..5ece05982d 100644 --- a/master/index.html +++ b/master/index.html @@ -19,7 +19,7 @@ - + @@ -968,7 +968,7 @@ See the
Lens v4 to v5 extension migrat - + diff --git a/master/search/search_index.json b/master/search/search_index.json index f67b9fc480..7bc4f427ff 100644 --- a/master/search/search_index.json +++ b/master/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Lens Extension API","text":"

Customize and enhance the Lens experience with the Lens Extension API. Use the extension API to create menus or page content. The same extension API was used to create many of Lens's core features. To install your first extension you should goto the extension page in lens.

This documentation describes:

  • How to build, run, test, and publish an extension.
  • How to take full advantage of the Lens Extension API.
  • Where to find guides and code samples to help get you started.
"},{"location":"#what-extensions-can-do","title":"What Extensions Can Do","text":"

Here are some examples of what you can achieve with the Extension API:

  • Add custom components & views in the UI - Extending the Lens Workbench

For an overview of the Lens Extension API, refer to the Common Capabilities page. Extension Guides Overview also includes a list of code samples and guides that illustrate various ways of using the Lens Extension API.

"},{"location":"#how-to-build-extensions","title":"How to Build Extensions","text":"

Here is what each section of the Lens Extension API docs can help you with:

  • Getting Started teaches fundamental concepts for building extensions with the Hello World sample.
  • Extension Capabilities dissects Lens's Extension API into smaller categories and points you to more detailed topics.
  • Extension Guides includes guides and code samples that explain specific usages of Lens Extension API.
  • Testing and Publishing includes in-depth guides on various extension development topics, such as testing and publishing extensions.
  • API Reference contains exhaustive references for the Lens Extension API, Contribution Points, and many other topics.
"},{"location":"#whats-new","title":"What's New","text":"

Just like Lens itself, the extension API updates on a monthly cadence, rolling out new features with every release.

Keep up with Lens and the Lens Extension API by reviewing the release notes.

"},{"location":"#important-changes-since-lens-v4","title":"Important changes since Lens v4","text":"

Lens has undergone major design improvements in v5, which have resulted in several large changes to the extension API. Workspaces are gone, and the catalog is introduced for containing clusters, as well as other items, including custom entities. Lens has migrated from using mobx 5 to mobx 6 for internal state management, and this may have ramifications for extension implementations. Although the API retains many components from v4, given these changes, extensions written for Lens v4 are not compatible with the Lens v5 extension API. See the Lens v4 to v5 extension migration notes on getting old extensions working in Lens v5.

"},{"location":"#looking-for-help","title":"Looking for Help","text":"

If you have questions for extension development, try asking on the Lens Forums. It's a public chatroom for Lens developers, where Lens team members chime in from time to time.

To provide feedback on the documentation or issues with the Lens Extension API, create new issues at lensapp/lens. Please use the labels area/documentation and/or area/extension.

"},{"location":"#downloading-lens","title":"Downloading Lens","text":"

Download Lens for macOS, Windows, or Linux.

"},{"location":"architecture/decisions/","title":"Architecture Decision Records","text":""},{"location":"extensions/extension-migration/","title":"Lens v4 to v5 Extension Migration Notes","text":"
  • Lens v5 inspects the version of the extension to ensure it is compatible. The package.json for your extension must have an \"engines\" field specifying the lens version that your extension is targeted for, e.g:
        \"engines\": {\n        \"lens\": \"^5.0.0-beta.7\"\n    },\n
    Note that Lens v5 supports all the range semantics that semver provides.
  • Types and components have been reorganized, many have been grouped by process (Main and Renderer) plus those not specific to a process (Common). For example the LensMainExtension class is now referred to by Main.LensExtension. See the API Reference for the new organization.
  • The globalPageMenus field of the Renderer extension class (now Renderer.LensExtension) is removed. Global pages can still be made accessible via the application menus and the status bar, as well as from the newly added Welcome menu.
  • The clusterFeatures field of the Renderer extension class (now Renderer.LensExtension) is removed. Cluster features can still be implemented but Lens no longer dictates how a feature's lifecycle (install/upgrade/uninstall) is managed. Renderer.K8sApi.ResourceStack provides the functionality to input and apply kubernetes resources to a cluster. It is up to the extension developer to manage the lifecycle. It could be applied automatically to a cluster by the extension or the end-user could be expected to install it, etc. from the cluster Settings page.
  • Lens v5 now relies on mobx 6 for state management. Extensions that use mobx will need to be modified to work with mobx 6. See Migrating from Mobx 4/5 for specific details.

For an example of an existing extension that is compatible with Lens v5 see the Lens Resource Map Extension

"},{"location":"extensions/api/","title":"API Reference","text":"

@k8slens/extensions / Exports

"},{"location":"extensions/api/#extension-api-reference","title":"Extension API Reference","text":""},{"location":"extensions/api/#apis","title":"APIs","text":"
  • Common
  • Main
  • Renderer
"},{"location":"extensions/api/modules/","title":"Modules","text":"

@k8slens/extensions / Exports

"},{"location":"extensions/api/modules/#k8slensextensions","title":"@k8slens/extensions","text":""},{"location":"extensions/api/modules/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/#namespaces","title":"Namespaces","text":"
  • Common
  • Main
  • Renderer
"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/","title":"Common.Catalog.CatalogCategory","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogCategory

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#class-catalogcategory","title":"Class: CatalogCategory","text":"

Common.Catalog.CatalogCategory

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#hierarchy","title":"Hierarchy","text":"
  • CatalogCategory_base

\u21b3 CatalogCategory

\u21b3\u21b3 KubernetesClusterCategory

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#properties","title":"Properties","text":"
  • apiVersion
  • filters
  • kind
  • metadata
  • spec
"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#methods","title":"Methods","text":"
  • addMenuFilter
  • filteredItems
  • getBadge
  • getId
  • getName
  • parseId
"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#constructor","title":"constructor","text":"

\u2022 new CatalogCategory()

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#inherited-from","title":"Inherited from","text":"

CatalogCategory_base.constructor

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#apiversion","title":"apiVersion","text":"

\u2022 Readonly Abstract apiVersion: string

The version of category that you are wanting to declare.

Currently supported values:

  • \"catalog.k8slens.dev/v1alpha1\"
"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#filters","title":"filters","text":"

\u2022 Protected Readonly filters: ObservableSet<AddMenuFilter>

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#kind","title":"kind","text":"

\u2022 Readonly Abstract kind: string

The kind of item you wish to declare.

Currently supported values:

  • \"CatalogCategory\"
"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#metadata","title":"metadata","text":"

\u2022 Readonly Abstract metadata: CatalogCategoryMetadata

The data about the category itself

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#spec","title":"spec","text":"

\u2022 Readonly Abstract spec: CatalogCategorySpec

The most important part of a category, as it is where entity versions are declared.

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#addmenufilter","title":"addMenuFilter","text":"

\u25b8 addMenuFilter(fn): Disposer

Add a filter for menu items of catalogAddMenu

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#parameters","title":"Parameters","text":"Name Type Description fn AddMenuFilter The function that should return a truthy value if that menu item should be displayed"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#returns","title":"Returns","text":"

Disposer

A function to remove that filter

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#filtereditems","title":"filteredItems","text":"

\u25b8 filteredItems(menuItems): CatalogEntityAddMenu[]

Filter menuItems according to the Category's set filters

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#parameters_1","title":"Parameters","text":"Name Type Description menuItems CatalogEntityAddMenu[] menu items to filter"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#returns_1","title":"Returns","text":"

CatalogEntityAddMenu[]

filtered menu items

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#getbadge","title":"getBadge","text":"

\u25b8 getBadge(): ReactNode

Get the badge of this category. Defaults to no badge. The badge is displayed next to the Category name in the Catalog Category menu

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#returns_2","title":"Returns","text":"

ReactNode

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#getid","title":"getId","text":"

\u25b8 getId(): string

Get the ID of this category

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#returns_3","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#getname","title":"getName","text":"

\u25b8 getName(): string

Get the name of this category

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#returns_4","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#parseid","title":"parseId","text":"

\u25b8 Static parseId(id): Object

Parse a category ID into parts.

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#parameters_2","title":"Parameters","text":"Name Type Description id string The id of a category is parse"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#returns_5","title":"Returns","text":"

Object

The group and kind parts of the ID

Name Type group? string kind? string"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/","title":"Common.Catalog.CatalogEntity","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogEntity

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#class-catalogentitymetadata-status-spec","title":"Class: CatalogEntity<Metadata, Status, Spec>","text":"

Common.Catalog.CatalogEntity

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends CatalogEntityMetadata = CatalogEntityMetadata Status extends CatalogEntityStatus = CatalogEntityStatus Spec extends CatalogEntitySpec = CatalogEntitySpec"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#hierarchy","title":"Hierarchy","text":"
  • CatalogEntity

\u21b3 KubernetesCluster

\u21b3 GeneralEntity

\u21b3 WebLink

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#implements","title":"Implements","text":"
  • CatalogEntityKindData
"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#methods","title":"Methods","text":"
  • getId
  • getName
  • getSource
  • isEnabled
  • onContextMenuOpen
  • onRun
  • onSettingsOpen
"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#constructor","title":"constructor","text":"

\u2022 new CatalogEntity<Metadata, Status, Spec>(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#type-parameters_1","title":"Type parameters","text":"Name Type Metadata extends CatalogEntityMetadata<Metadata> = CatalogEntityMetadata Status extends CatalogEntityStatus = CatalogEntityStatus Spec extends CatalogEntitySpec = CatalogEntitySpec"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb CatalogEntityData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#apiversion","title":"apiVersion","text":"

\u2022 Readonly Abstract apiVersion: string

The group and version of this class.

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#implementation-of","title":"Implementation of","text":"

CatalogEntityKindData.apiVersion

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#kind","title":"kind","text":"

\u2022 Readonly Abstract kind: string

A DNS label name of the entity.

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#implementation-of_1","title":"Implementation of","text":"

CatalogEntityKindData.kind

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#metadata","title":"metadata","text":"

\u2022 metadata: Metadata

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#spec","title":"spec","text":"

\u2022 spec: Spec

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#status","title":"status","text":"

\u2022 status: Status

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#getid","title":"getId","text":"

\u25b8 getId(): string

Get the UID of this entity

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#getname","title":"getName","text":"

\u25b8 getName(): string

Get the name of this entity

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#returns_1","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#getsource","title":"getSource","text":"

\u25b8 getSource(): string

Get the specified source of this entity, defaulting to \"unknown\" if not provided

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#returns_2","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#isenabled","title":"isEnabled","text":"

\u25b8 isEnabled(): boolean

Get if this entity is enabled.

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#returns_3","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#oncontextmenuopen","title":"onContextMenuOpen","text":"

\u25b8 Optional onContextMenuOpen(context): void | Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#parameters_1","title":"Parameters","text":"Name Type context CatalogEntityContextMenuContext"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#returns_4","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#onrun","title":"onRun","text":"

\u25b8 Optional onRun(context): void | Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#parameters_2","title":"Parameters","text":"Name Type context CatalogEntityActionContext"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#returns_5","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#onsettingsopen","title":"onSettingsOpen","text":"

\u25b8 Optional onSettingsOpen(context): void | Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#parameters_3","title":"Parameters","text":"Name Type context CatalogEntitySettingsContext"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#returns_6","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/","title":"Common.Catalog.GeneralEntity","text":"

@k8slens/extensions / Exports / Common / Catalog / GeneralEntity

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#class-generalentity","title":"Class: GeneralEntity","text":"

Common.Catalog.GeneralEntity

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#hierarchy","title":"Hierarchy","text":"
  • CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, GeneralEntitySpec>

\u21b3 GeneralEntity

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#methods","title":"Methods","text":"
  • getId
  • getName
  • getSource
  • isEnabled
  • onContextMenuOpen
  • onRun
  • onSettingsOpen
"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#constructor","title":"constructor","text":"

\u2022 new GeneralEntity(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb CatalogEntityData<CatalogEntityMetadata, CatalogEntityStatus, GeneralEntitySpec>"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#inherited-from","title":"Inherited from","text":"

CatalogEntity.constructor

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#apiversion","title":"apiVersion","text":"

\u2022 Readonly apiVersion: \"entity.k8slens.dev/v1alpha1\"

The group and version of this class.

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#overrides","title":"Overrides","text":"

CatalogEntity.apiVersion

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#kind","title":"kind","text":"

\u2022 Readonly kind: \"General\"

A DNS label name of the entity.

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#overrides_1","title":"Overrides","text":"

CatalogEntity.kind

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#metadata","title":"metadata","text":"

\u2022 metadata: CatalogEntityMetadata

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#inherited-from_1","title":"Inherited from","text":"

CatalogEntity.metadata

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#spec","title":"spec","text":"

\u2022 spec: GeneralEntitySpec

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#inherited-from_2","title":"Inherited from","text":"

CatalogEntity.spec

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#status","title":"status","text":"

\u2022 status: CatalogEntityStatus

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#inherited-from_3","title":"Inherited from","text":"

CatalogEntity.status

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#getid","title":"getId","text":"

\u25b8 getId(): string

Get the UID of this entity

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#inherited-from_4","title":"Inherited from","text":"

CatalogEntity.getId

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#getname","title":"getName","text":"

\u25b8 getName(): string

Get the name of this entity

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#returns_1","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#inherited-from_5","title":"Inherited from","text":"

CatalogEntity.getName

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#getsource","title":"getSource","text":"

\u25b8 getSource(): string

Get the specified source of this entity, defaulting to \"unknown\" if not provided

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#returns_2","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#inherited-from_6","title":"Inherited from","text":"

CatalogEntity.getSource

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#isenabled","title":"isEnabled","text":"

\u25b8 isEnabled(): boolean

Get if this entity is enabled.

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#returns_3","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#inherited-from_7","title":"Inherited from","text":"

CatalogEntity.isEnabled

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#oncontextmenuopen","title":"onContextMenuOpen","text":"

\u25b8 Optional onContextMenuOpen(context): void | Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#parameters_1","title":"Parameters","text":"Name Type context CatalogEntityContextMenuContext"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#returns_4","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#inherited-from_8","title":"Inherited from","text":"

CatalogEntity.onContextMenuOpen

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#onrun","title":"onRun","text":"

\u25b8 onRun(context): Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#parameters_2","title":"Parameters","text":"Name Type context CatalogEntityActionContext"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#returns_5","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#overrides_2","title":"Overrides","text":"

CatalogEntity.onRun

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#onsettingsopen","title":"onSettingsOpen","text":"

\u25b8 Optional onSettingsOpen(context): void | Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#parameters_3","title":"Parameters","text":"Name Type context CatalogEntitySettingsContext"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#returns_6","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#inherited-from_9","title":"Inherited from","text":"

CatalogEntity.onSettingsOpen

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/","title":"Common.Catalog.KubernetesCluster","text":"

@k8slens/extensions / Exports / Common / Catalog / KubernetesCluster

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#class-kubernetesclustermetadata-status-spec","title":"Class: KubernetesCluster<Metadata, Status, Spec>","text":"

Common.Catalog.KubernetesCluster

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubernetesClusterMetadata = KubernetesClusterMetadata Status extends KubernetesClusterStatus = KubernetesClusterStatus Spec extends KubernetesClusterSpec = KubernetesClusterSpec"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#hierarchy","title":"Hierarchy","text":"
  • CatalogEntity<Metadata, Status, Spec>

\u21b3 KubernetesCluster

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiVersion
  • kind
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#methods","title":"Methods","text":"
  • connect
  • disconnect
  • getId
  • getName
  • getSource
  • isEnabled
  • onContextMenuOpen
  • onDetailsOpen
  • onRun
  • onSettingsOpen
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#constructor","title":"constructor","text":"

\u2022 new KubernetesCluster<Metadata, Status, Spec>(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#type-parameters_1","title":"Type parameters","text":"Name Type Metadata extends KubernetesClusterMetadata<Metadata> = KubernetesClusterMetadata Status extends KubernetesClusterStatus = KubernetesClusterStatus Spec extends KubernetesClusterSpec<Spec> = KubernetesClusterSpec"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb CatalogEntityData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#inherited-from","title":"Inherited from","text":"

CatalogEntity.constructor

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#apiversion","title":"apiVersion","text":"

\u2022 Readonly apiVersion: string

The group and version of this class.

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#overrides","title":"Overrides","text":"

CatalogEntity.apiVersion

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#kind","title":"kind","text":"

\u2022 Readonly kind: string

A DNS label name of the entity.

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#overrides_1","title":"Overrides","text":"

CatalogEntity.kind

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#metadata","title":"metadata","text":"

\u2022 metadata: Metadata

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#inherited-from_1","title":"Inherited from","text":"

CatalogEntity.metadata

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#spec","title":"spec","text":"

\u2022 spec: Spec

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#inherited-from_2","title":"Inherited from","text":"

CatalogEntity.spec

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#status","title":"status","text":"

\u2022 status: Status

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#inherited-from_3","title":"Inherited from","text":"

CatalogEntity.status

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#apiversion_1","title":"apiVersion","text":"

\u25aa Static Readonly apiVersion: string

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: string

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#connect","title":"connect","text":"

\u25b8 connect(): Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#returns","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#disconnect","title":"disconnect","text":"

\u25b8 disconnect(): Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#returns_1","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#getid","title":"getId","text":"

\u25b8 getId(): string

Get the UID of this entity

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#returns_2","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#inherited-from_4","title":"Inherited from","text":"

CatalogEntity.getId

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#getname","title":"getName","text":"

\u25b8 getName(): string

Get the name of this entity

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#returns_3","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#inherited-from_5","title":"Inherited from","text":"

CatalogEntity.getName

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#getsource","title":"getSource","text":"

\u25b8 getSource(): string

Get the specified source of this entity, defaulting to \"unknown\" if not provided

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#returns_4","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#inherited-from_6","title":"Inherited from","text":"

CatalogEntity.getSource

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#isenabled","title":"isEnabled","text":"

\u25b8 isEnabled(): boolean

Get if this entity is enabled.

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#inherited-from_7","title":"Inherited from","text":"

CatalogEntity.isEnabled

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#oncontextmenuopen","title":"onContextMenuOpen","text":"

\u25b8 onContextMenuOpen(context): void

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#parameters_1","title":"Parameters","text":"Name Type context CatalogEntityContextMenuContext"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#returns_6","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#overrides_2","title":"Overrides","text":"

CatalogEntity.onContextMenuOpen

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#ondetailsopen","title":"onDetailsOpen","text":"

\u25b8 onDetailsOpen(): void

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#returns_7","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#onrun","title":"onRun","text":"

\u25b8 onRun(context): Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#parameters_2","title":"Parameters","text":"Name Type context CatalogEntityActionContext"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#returns_8","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#overrides_3","title":"Overrides","text":"

CatalogEntity.onRun

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#onsettingsopen","title":"onSettingsOpen","text":"

\u25b8 onSettingsOpen(): void

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#returns_9","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#overrides_4","title":"Overrides","text":"

CatalogEntity.onSettingsOpen

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/","title":"Common.Catalog.KubernetesClusterCategory","text":"

@k8slens/extensions / Exports / Common / Catalog / KubernetesClusterCategory

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#class-kubernetesclustercategory","title":"Class: KubernetesClusterCategory","text":"

Common.Catalog.KubernetesClusterCategory

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#hierarchy","title":"Hierarchy","text":"
  • CatalogCategory

\u21b3 KubernetesClusterCategory

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#properties","title":"Properties","text":"
  • apiVersion
  • filters
  • kind
  • metadata
  • spec
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#methods","title":"Methods","text":"
  • addMenuFilter
  • filteredItems
  • getBadge
  • getId
  • getName
  • parseId
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#constructor","title":"constructor","text":"

\u2022 new KubernetesClusterCategory()

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#inherited-from","title":"Inherited from","text":"

CatalogCategory.constructor

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#apiversion","title":"apiVersion","text":"

\u2022 Readonly apiVersion: \"catalog.k8slens.dev/v1alpha1\"

The version of category that you are wanting to declare.

Currently supported values:

  • \"catalog.k8slens.dev/v1alpha1\"
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#overrides","title":"Overrides","text":"

CatalogCategory.apiVersion

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#filters","title":"filters","text":"

\u2022 Protected Readonly filters: ObservableSet<AddMenuFilter>

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#inherited-from_1","title":"Inherited from","text":"

CatalogCategory.filters

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#kind","title":"kind","text":"

\u2022 Readonly kind: \"CatalogCategory\"

The kind of item you wish to declare.

Currently supported values:

  • \"CatalogCategory\"
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#overrides_1","title":"Overrides","text":"

CatalogCategory.kind

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#metadata","title":"metadata","text":"

\u2022 metadata: Object

The data about the category itself

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#type-declaration","title":"Type declaration","text":"Name Type icon string name string"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#overrides_2","title":"Overrides","text":"

CatalogCategory.metadata

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#spec","title":"spec","text":"

\u2022 spec: CatalogCategorySpec

The most important part of a category, as it is where entity versions are declared.

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#overrides_3","title":"Overrides","text":"

CatalogCategory.spec

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#addmenufilter","title":"addMenuFilter","text":"

\u25b8 addMenuFilter(fn): Disposer

Add a filter for menu items of catalogAddMenu

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#parameters","title":"Parameters","text":"Name Type Description fn AddMenuFilter The function that should return a truthy value if that menu item should be displayed"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#returns","title":"Returns","text":"

Disposer

A function to remove that filter

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#inherited-from_2","title":"Inherited from","text":"

CatalogCategory.addMenuFilter

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#filtereditems","title":"filteredItems","text":"

\u25b8 filteredItems(menuItems): CatalogEntityAddMenu[]

Filter menuItems according to the Category's set filters

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#parameters_1","title":"Parameters","text":"Name Type Description menuItems CatalogEntityAddMenu[] menu items to filter"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#returns_1","title":"Returns","text":"

CatalogEntityAddMenu[]

filtered menu items

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#inherited-from_3","title":"Inherited from","text":"

CatalogCategory.filteredItems

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#getbadge","title":"getBadge","text":"

\u25b8 getBadge(): ReactNode

Get the badge of this category. Defaults to no badge. The badge is displayed next to the Category name in the Catalog Category menu

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#returns_2","title":"Returns","text":"

ReactNode

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#inherited-from_4","title":"Inherited from","text":"

CatalogCategory.getBadge

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#getid","title":"getId","text":"

\u25b8 getId(): string

Get the ID of this category

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#returns_3","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#inherited-from_5","title":"Inherited from","text":"

CatalogCategory.getId

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#getname","title":"getName","text":"

\u25b8 getName(): string

Get the name of this category

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#returns_4","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#inherited-from_6","title":"Inherited from","text":"

CatalogCategory.getName

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#parseid","title":"parseId","text":"

\u25b8 Static parseId(id): Object

Parse a category ID into parts.

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#parameters_2","title":"Parameters","text":"Name Type Description id string The id of a category is parse"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#returns_5","title":"Returns","text":"

Object

The group and kind parts of the ID

Name Type group? string kind? string"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#inherited-from_7","title":"Inherited from","text":"

CatalogCategory.parseId

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/","title":"Common.Catalog.WebLink","text":"

@k8slens/extensions / Exports / Common / Catalog / WebLink

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#class-weblink","title":"Class: WebLink","text":"

Common.Catalog.WebLink

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#hierarchy","title":"Hierarchy","text":"
  • CatalogEntity<CatalogEntityMetadata, WebLinkStatus, WebLinkSpec>

\u21b3 WebLink

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Common.Catalog.WebLink/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiVersion
  • kind
"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#methods","title":"Methods","text":"
  • getId
  • getName
  • getSource
  • isEnabled
  • onContextMenuOpen
  • onRun
  • onSettingsOpen
"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Common.Catalog.WebLink/#constructor","title":"constructor","text":"

\u2022 new WebLink(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb CatalogEntityData<CatalogEntityMetadata, WebLinkStatus, WebLinkSpec>"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#inherited-from","title":"Inherited from","text":"

CatalogEntity.constructor

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Common.Catalog.WebLink/#apiversion","title":"apiVersion","text":"

\u2022 Readonly apiVersion: \"entity.k8slens.dev/v1alpha1\"

The group and version of this class.

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#overrides","title":"Overrides","text":"

CatalogEntity.apiVersion

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#kind","title":"kind","text":"

\u2022 Readonly kind: \"WebLink\"

A DNS label name of the entity.

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#overrides_1","title":"Overrides","text":"

CatalogEntity.kind

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#metadata","title":"metadata","text":"

\u2022 metadata: CatalogEntityMetadata

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#inherited-from_1","title":"Inherited from","text":"

CatalogEntity.metadata

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#spec","title":"spec","text":"

\u2022 spec: WebLinkSpec

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#inherited-from_2","title":"Inherited from","text":"

CatalogEntity.spec

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#status","title":"status","text":"

\u2022 status: WebLinkStatus

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#inherited-from_3","title":"Inherited from","text":"

CatalogEntity.status

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#apiversion_1","title":"apiVersion","text":"

\u25aa Static Readonly apiVersion: \"entity.k8slens.dev/v1alpha1\"

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"WebLink\"

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Common.Catalog.WebLink/#getid","title":"getId","text":"

\u25b8 getId(): string

Get the UID of this entity

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#inherited-from_4","title":"Inherited from","text":"

CatalogEntity.getId

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#getname","title":"getName","text":"

\u25b8 getName(): string

Get the name of this entity

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#returns_1","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#inherited-from_5","title":"Inherited from","text":"

CatalogEntity.getName

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#getsource","title":"getSource","text":"

\u25b8 getSource(): string

Get the specified source of this entity, defaulting to \"unknown\" if not provided

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#returns_2","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#inherited-from_6","title":"Inherited from","text":"

CatalogEntity.getSource

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#isenabled","title":"isEnabled","text":"

\u25b8 isEnabled(): boolean

Get if this entity is enabled.

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#returns_3","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#inherited-from_7","title":"Inherited from","text":"

CatalogEntity.isEnabled

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#oncontextmenuopen","title":"onContextMenuOpen","text":"

\u25b8 onContextMenuOpen(context): void

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#parameters_1","title":"Parameters","text":"Name Type context CatalogEntityContextMenuContext"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#returns_4","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#overrides_2","title":"Overrides","text":"

CatalogEntity.onContextMenuOpen

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#onrun","title":"onRun","text":"

\u25b8 onRun(): Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#returns_5","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#overrides_3","title":"Overrides","text":"

CatalogEntity.onRun

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#onsettingsopen","title":"onSettingsOpen","text":"

\u25b8 Optional onSettingsOpen(context): void | Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#parameters_2","title":"Parameters","text":"Name Type context CatalogEntitySettingsContext"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#returns_6","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#inherited-from_8","title":"Inherited from","text":"

CatalogEntity.onSettingsOpen

"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/","title":"Common.EventBus.EventEmitter","text":"

@k8slens/extensions / Exports / Common / EventBus / EventEmitter

"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#class-eventemitterd","title":"Class: EventEmitter<D>","text":"

Common.EventBus.EventEmitter

"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#type-parameters","title":"Type parameters","text":"Name Type D extends any[]"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#properties","title":"Properties","text":"
  • listeners
"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#methods","title":"Methods","text":"
  • addListener
  • emit
  • removeAllListeners
  • removeListener
"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#constructor","title":"constructor","text":"

\u2022 new EventEmitter<D>()

"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#type-parameters_1","title":"Type parameters","text":"Name Type D extends any[]"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#listeners","title":"listeners","text":"

\u2022 Protected listeners: [EventEmitterCallback<D>, EventEmitterOptions][]

"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#addlistener","title":"addListener","text":"

\u25b8 addListener(callback, options?): void

"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#parameters","title":"Parameters","text":"Name Type callback EventEmitterCallback<D> options? EventEmitterOptions"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#emit","title":"emit","text":"

\u25b8 emit(...data): void

"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#parameters_1","title":"Parameters","text":"Name Type ...data D"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#removealllisteners","title":"removeAllListeners","text":"

\u25b8 removeAllListeners(): void

"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#removelistener","title":"removeListener","text":"

\u25b8 removeListener(callback): void

"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#parameters_2","title":"Parameters","text":"Name Type callback EventEmitterCallback<D>"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Common.LensExtension/","title":"Common.LensExtension","text":"

@k8slens/extensions / Exports / Common / LensExtension

"},{"location":"extensions/api/classes/Common.LensExtension/#class-lensextension","title":"Class: LensExtension","text":"

Common.LensExtension

"},{"location":"extensions/api/classes/Common.LensExtension/#hierarchy","title":"Hierarchy","text":"
  • LensExtension

\u21b3 LensExtension

\u21b3 LensExtension

"},{"location":"extensions/api/classes/Common.LensExtension/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Common.LensExtension/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Common.LensExtension/#properties","title":"Properties","text":"
  • id
  • isBundled
  • manifest
  • manifestPath
  • protocolHandlers
"},{"location":"extensions/api/classes/Common.LensExtension/#accessors","title":"Accessors","text":"
  • description
  • isEnabled
  • name
  • sanitizedExtensionId
  • storeName
  • version
"},{"location":"extensions/api/classes/Common.LensExtension/#methods","title":"Methods","text":"
  • activate
  • disable
  • enable
  • getExtensionFileFolder
  • onActivate
  • onDeactivate
"},{"location":"extensions/api/classes/Common.LensExtension/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Common.LensExtension/#constructor","title":"constructor","text":"

\u2022 new LensExtension(deps, \u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Common.LensExtension/#parameters","title":"Parameters","text":"Name Type deps LensExtensionDependencies \u00abdestructured\u00bb InstalledExtension"},{"location":"extensions/api/classes/Common.LensExtension/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Common.LensExtension/#id","title":"id","text":"

\u2022 Readonly id: string

"},{"location":"extensions/api/classes/Common.LensExtension/#isbundled","title":"isBundled","text":"

\u2022 Readonly isBundled: boolean

"},{"location":"extensions/api/classes/Common.LensExtension/#manifest","title":"manifest","text":"

\u2022 Readonly manifest: LensExtensionManifest

"},{"location":"extensions/api/classes/Common.LensExtension/#manifestpath","title":"manifestPath","text":"

\u2022 Readonly manifestPath: string

"},{"location":"extensions/api/classes/Common.LensExtension/#protocolhandlers","title":"protocolHandlers","text":"

\u2022 protocolHandlers: ProtocolHandlerRegistration[]

"},{"location":"extensions/api/classes/Common.LensExtension/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Common.LensExtension/#description","title":"description","text":"

\u2022 get description(): undefined | string

"},{"location":"extensions/api/classes/Common.LensExtension/#returns","title":"Returns","text":"

undefined | string

"},{"location":"extensions/api/classes/Common.LensExtension/#isenabled","title":"isEnabled","text":"

\u2022 get isEnabled(): boolean

"},{"location":"extensions/api/classes/Common.LensExtension/#returns_1","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Common.LensExtension/#name","title":"name","text":"

\u2022 get name(): string

"},{"location":"extensions/api/classes/Common.LensExtension/#returns_2","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.LensExtension/#sanitizedextensionid","title":"sanitizedExtensionId","text":"

\u2022 get sanitizedExtensionId(): string

"},{"location":"extensions/api/classes/Common.LensExtension/#returns_3","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.LensExtension/#storename","title":"storeName","text":"

\u2022 get storeName(): string

"},{"location":"extensions/api/classes/Common.LensExtension/#returns_4","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.LensExtension/#version","title":"version","text":"

\u2022 get version(): string

"},{"location":"extensions/api/classes/Common.LensExtension/#returns_5","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.LensExtension/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Common.LensExtension/#activate","title":"activate","text":"

\u25b8 activate(): Promise<void>

"},{"location":"extensions/api/classes/Common.LensExtension/#returns_6","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Common.LensExtension/#disable","title":"disable","text":"

\u25b8 disable(): Promise<void>

"},{"location":"extensions/api/classes/Common.LensExtension/#returns_7","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Common.LensExtension/#enable","title":"enable","text":"

\u25b8 enable(): Promise<void>

"},{"location":"extensions/api/classes/Common.LensExtension/#returns_8","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Common.LensExtension/#getextensionfilefolder","title":"getExtensionFileFolder","text":"

\u25b8 getExtensionFileFolder(): Promise<string>

getExtensionFileFolder returns the path to an already created folder. This folder is for the sole use of this extension.

Note: there is no security done on this folder, only obfuscation of the folder name.

"},{"location":"extensions/api/classes/Common.LensExtension/#returns_9","title":"Returns","text":"

Promise<string>

"},{"location":"extensions/api/classes/Common.LensExtension/#onactivate","title":"onActivate","text":"

\u25b8 Protected onActivate(): void | Promise<void>

"},{"location":"extensions/api/classes/Common.LensExtension/#returns_10","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/classes/Common.LensExtension/#ondeactivate","title":"onDeactivate","text":"

\u25b8 Protected onDeactivate(): void | Promise<void>

"},{"location":"extensions/api/classes/Common.LensExtension/#returns_11","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/","title":"Common.Store.ExtensionStore","text":"

@k8slens/extensions / Exports / Common / Store / ExtensionStore

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#class-extensionstoret","title":"Class: ExtensionStore<T>","text":"

Common.Store.ExtensionStore

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#type-parameters","title":"Type parameters","text":"Name Type T extends object"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#properties","title":"Properties","text":"
  • extension
  • persistentStorage
  • rawParams
"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#methods","title":"Methods","text":"
  • cwd
  • fromStore
  • load
  • loadExtension
  • toJSON
  • createInstance
  • getInstance
  • resetInstance
"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#constructor","title":"constructor","text":"

\u2022 new ExtensionStore<T>(rawParams)

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#type-parameters_1","title":"Type parameters","text":"Name Type T extends object"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#parameters","title":"Parameters","text":"Name Type rawParams ExtensionStoreParams<T>"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#extension","title":"extension","text":"

\u2022 Protected Optional extension: LensExtension

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#persistentstorage","title":"persistentStorage","text":"

\u2022 Protected Optional persistentStorage: PersistentStorage

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#rawparams","title":"rawParams","text":"

\u2022 Protected Readonly rawParams: ExtensionStoreParams<T>

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#cwd","title":"cwd","text":"

\u25b8 Protected cwd(): string

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#fromstore","title":"fromStore","text":"

\u25b8 Abstract fromStore(data): void

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#parameters_1","title":"Parameters","text":"Name Type data Partial<T>"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#load","title":"load","text":"

\u25b8 load(): void

Deprecated

Never use this method. Instead call loadExtension

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#loadextension","title":"loadExtension","text":"

\u25b8 loadExtension(extension): void

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#parameters_2","title":"Parameters","text":"Name Type extension LensExtension"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#tojson","title":"toJSON","text":"

\u25b8 Abstract toJSON(): T

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#returns_4","title":"Returns","text":"

T

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#createinstance","title":"createInstance","text":"

\u25b8 Static createInstance<T, R>(this, ...args): T

Deprecated

This is a form of global shared state. Just call new Store(...)

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#type-parameters_2","title":"Type parameters","text":"Name Type T T R extends any[]"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#parameters_3","title":"Parameters","text":"Name Type this StaticThis<T, R> ...args R"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#returns_5","title":"Returns","text":"

T

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#getinstance","title":"getInstance","text":"

\u25b8 Static getInstance<T, R>(this, strict?): T

Deprecated

This is a form of global shared state. Just call new Store(...)

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#type-parameters_3","title":"Type parameters","text":"Name Type T T R extends any[]"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#parameters_4","title":"Parameters","text":"Name Type this StaticThis<T, R> strict? true"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#returns_6","title":"Returns","text":"

T

\u25b8 Static getInstance<T, R>(this, strict): undefined | T

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#type-parameters_4","title":"Type parameters","text":"Name Type T T R extends any[]"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#parameters_5","title":"Parameters","text":"Name Type this StaticThis<T, R> strict false"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#returns_7","title":"Returns","text":"

undefined | T

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#resetinstance","title":"resetInstance","text":"

\u25b8 Static resetInstance(): void

Deprecated

This is a form of global shared state. Just call new Store(...)

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#returns_8","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Common.Util.Singleton/","title":"Common.Util.Singleton","text":"

@k8slens/extensions / Exports / Common / Util / Singleton

"},{"location":"extensions/api/classes/Common.Util.Singleton/#class-singleton","title":"Class: Singleton","text":"

Common.Util.Singleton

Deprecated

This is a form of global shared state

"},{"location":"extensions/api/classes/Common.Util.Singleton/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Common.Util.Singleton/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Common.Util.Singleton/#methods","title":"Methods","text":"
  • createInstance
  • getInstance
  • resetInstance
"},{"location":"extensions/api/classes/Common.Util.Singleton/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Common.Util.Singleton/#constructor","title":"constructor","text":"

\u2022 new Singleton()

"},{"location":"extensions/api/classes/Common.Util.Singleton/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Common.Util.Singleton/#createinstance","title":"createInstance","text":"

\u25b8 Static createInstance<T, R>(this, ...args): T

Creates the single instance of the child class if one was not already created.

Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls.

Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used.

"},{"location":"extensions/api/classes/Common.Util.Singleton/#type-parameters","title":"Type parameters","text":"Name Type T extends Singleton<T> R extends any[]"},{"location":"extensions/api/classes/Common.Util.Singleton/#parameters","title":"Parameters","text":"Name Type Description this StaticThis<T, R> Implicit argument that is the child class type ...args R The constructor arguments for the child class"},{"location":"extensions/api/classes/Common.Util.Singleton/#returns","title":"Returns","text":"

T

An instance of the child class

"},{"location":"extensions/api/classes/Common.Util.Singleton/#getinstance","title":"getInstance","text":"

\u25b8 Static getInstance<T, R>(this, strict?): T

Get the instance of the child class that was previously created.

"},{"location":"extensions/api/classes/Common.Util.Singleton/#type-parameters_1","title":"Type parameters","text":"Name Type T T R extends any[]"},{"location":"extensions/api/classes/Common.Util.Singleton/#parameters_1","title":"Parameters","text":"Name Type Description this StaticThis<T, R> Implicit argument that is the child class type strict? true If false will return undefined instead of throwing when an instance doesn't exist. Default: true"},{"location":"extensions/api/classes/Common.Util.Singleton/#returns_1","title":"Returns","text":"

T

An instance of the child class

\u25b8 Static getInstance<T, R>(this, strict): undefined | T

"},{"location":"extensions/api/classes/Common.Util.Singleton/#type-parameters_2","title":"Type parameters","text":"Name Type T T R extends any[]"},{"location":"extensions/api/classes/Common.Util.Singleton/#parameters_2","title":"Parameters","text":"Name Type this StaticThis<T, R> strict false"},{"location":"extensions/api/classes/Common.Util.Singleton/#returns_2","title":"Returns","text":"

undefined | T

"},{"location":"extensions/api/classes/Common.Util.Singleton/#resetinstance","title":"resetInstance","text":"

\u25b8 Static resetInstance(): void

Delete the instance of the child class.

Note: this doesn't prevent callers of getInstance from storing the result in a global.

There is no way in JS or TS to prevent globals like that.

"},{"location":"extensions/api/classes/Common.Util.Singleton/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.Ipc/","title":"Main.Ipc","text":"

@k8slens/extensions / Exports / Main / Ipc

"},{"location":"extensions/api/classes/Main.Ipc/#class-ipc","title":"Class: Ipc","text":"

Main.Ipc

"},{"location":"extensions/api/classes/Main.Ipc/#hierarchy","title":"Hierarchy","text":"
  • IpcRegistrar

\u21b3 Ipc

"},{"location":"extensions/api/classes/Main.Ipc/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.Ipc/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.Ipc/#properties","title":"Properties","text":"
  • [IpcPrefix]
  • extension
"},{"location":"extensions/api/classes/Main.Ipc/#methods","title":"Methods","text":"
  • broadcast
  • handle
  • listen
  • createInstance
  • getInstance
  • resetInstance
"},{"location":"extensions/api/classes/Main.Ipc/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.Ipc/#constructor","title":"constructor","text":"

\u2022 new Ipc(extension)

"},{"location":"extensions/api/classes/Main.Ipc/#parameters","title":"Parameters","text":"Name Type extension LensExtension"},{"location":"extensions/api/classes/Main.Ipc/#overrides","title":"Overrides","text":"

IpcRegistrar.constructor

"},{"location":"extensions/api/classes/Main.Ipc/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.Ipc/#ipcprefix","title":"[IpcPrefix]","text":"

\u2022 Readonly [IpcPrefix]: string

"},{"location":"extensions/api/classes/Main.Ipc/#inherited-from","title":"Inherited from","text":"

IpcRegistrar.[IpcPrefix]

"},{"location":"extensions/api/classes/Main.Ipc/#extension","title":"extension","text":"

\u2022 Protected Readonly extension: LensExtension

"},{"location":"extensions/api/classes/Main.Ipc/#inherited-from_1","title":"Inherited from","text":"

IpcRegistrar.extension

"},{"location":"extensions/api/classes/Main.Ipc/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.Ipc/#broadcast","title":"broadcast","text":"

\u25b8 broadcast(channel, ...args): void

"},{"location":"extensions/api/classes/Main.Ipc/#parameters_1","title":"Parameters","text":"Name Type Description channel string The channel to broadcast to your whole extension, both main and renderer ...args any[] The arguments passed to all listeners"},{"location":"extensions/api/classes/Main.Ipc/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.Ipc/#inherited-from_2","title":"Inherited from","text":"

IpcRegistrar.broadcast

"},{"location":"extensions/api/classes/Main.Ipc/#handle","title":"handle","text":"

\u25b8 handle(channel, handler): void

Declare a RPC over channel. Lens will cleanup when the extension is disabled or uninstalled

"},{"location":"extensions/api/classes/Main.Ipc/#parameters_2","title":"Parameters","text":"Name Type Description channel string The name of the RPC handler (event: IpcMainInvokeEvent, ...args: any[]) => any The remote procedure that is called"},{"location":"extensions/api/classes/Main.Ipc/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.Ipc/#listen","title":"listen","text":"

\u25b8 listen(channel, listener): Disposer

Listen for broadcasts within your extension

"},{"location":"extensions/api/classes/Main.Ipc/#parameters_3","title":"Parameters","text":"Name Type Description channel string The channel to listen for broadcasts on listener (event: IpcRendererEvent, ...args: any[]) => any The function that will be called with the arguments of the broadcast"},{"location":"extensions/api/classes/Main.Ipc/#returns_2","title":"Returns","text":"

Disposer

An optional disposer, Lens will cleanup when the extension is disabled or uninstalled even if this is not called

"},{"location":"extensions/api/classes/Main.Ipc/#createinstance","title":"createInstance","text":"

\u25b8 Static createInstance<T, R>(this, ...args): T

Creates the single instance of the child class if one was not already created.

Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls.

Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used.

"},{"location":"extensions/api/classes/Main.Ipc/#type-parameters","title":"Type parameters","text":"Name Type T extends Singleton<T> R extends any[]"},{"location":"extensions/api/classes/Main.Ipc/#parameters_4","title":"Parameters","text":"Name Type Description this StaticThis<T, R> Implicit argument that is the child class type ...args R The constructor arguments for the child class"},{"location":"extensions/api/classes/Main.Ipc/#returns_3","title":"Returns","text":"

T

An instance of the child class

"},{"location":"extensions/api/classes/Main.Ipc/#inherited-from_3","title":"Inherited from","text":"

IpcRegistrar.createInstance

"},{"location":"extensions/api/classes/Main.Ipc/#getinstance","title":"getInstance","text":"

\u25b8 Static getInstance<T, R>(this, strict?): T

Get the instance of the child class that was previously created.

"},{"location":"extensions/api/classes/Main.Ipc/#type-parameters_1","title":"Type parameters","text":"Name Type T T R extends any[]"},{"location":"extensions/api/classes/Main.Ipc/#parameters_5","title":"Parameters","text":"Name Type Description this StaticThis<T, R> Implicit argument that is the child class type strict? true If false will return undefined instead of throwing when an instance doesn't exist. Default: true"},{"location":"extensions/api/classes/Main.Ipc/#returns_4","title":"Returns","text":"

T

An instance of the child class

"},{"location":"extensions/api/classes/Main.Ipc/#inherited-from_4","title":"Inherited from","text":"

IpcRegistrar.getInstance

\u25b8 Static getInstance<T, R>(this, strict): undefined | T

"},{"location":"extensions/api/classes/Main.Ipc/#type-parameters_2","title":"Type parameters","text":"Name Type T T R extends any[]"},{"location":"extensions/api/classes/Main.Ipc/#parameters_6","title":"Parameters","text":"Name Type this StaticThis<T, R> strict false"},{"location":"extensions/api/classes/Main.Ipc/#returns_5","title":"Returns","text":"

undefined | T

"},{"location":"extensions/api/classes/Main.Ipc/#inherited-from_5","title":"Inherited from","text":"

IpcRegistrar.getInstance

"},{"location":"extensions/api/classes/Main.Ipc/#resetinstance","title":"resetInstance","text":"

\u25b8 Static resetInstance(): void

Delete the instance of the child class.

Note: this doesn't prevent callers of getInstance from storing the result in a global.

There is no way in JS or TS to prevent globals like that.

"},{"location":"extensions/api/classes/Main.Ipc/#returns_6","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.Ipc/#inherited-from_6","title":"Inherited from","text":"

IpcRegistrar.resetInstance

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/","title":"Main.K8sApi.ClusterRole","text":"

@k8slens/extensions / Exports / Main / K8sApi / ClusterRole

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#class-clusterrole","title":"Class: ClusterRole","text":"

Main.K8sApi.ClusterRole

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<ClusterScopedMetadata, void, void>

\u21b3 ClusterRole

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#properties","title":"Properties","text":"
  • aggregationRule
  • apiVersion
  • kind
  • metadata
  • rules
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getRules
  • getScopedName
  • getSearchFields
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#constructor","title":"constructor","text":"

\u2022 new ClusterRole(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb ClusterRoleData"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#overrides","title":"Overrides","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#aggregationrule","title":"aggregationRule","text":"

\u2022 Optional aggregationRule: AggregationRule

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_1","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#metadata","title":"metadata","text":"

\u2022 metadata: ClusterScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_2","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#rules","title":"rules","text":"

\u2022 Optional rules: PolicyRule[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#spec","title":"spec","text":"

\u2022 spec: void

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_3","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#status","title":"status","text":"

\u2022 Optional status: void

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_4","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#apibase","title":"apiBase","text":"

\u25aa Static apiBase: string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#overrides_1","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_5","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_6","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#kind_1","title":"kind","text":"

\u25aa Static kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#overrides_2","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#namespaced","title":"namespaced","text":"

\u25aa Static namespaced: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#overrides_3","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_13","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_14","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_15","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_16","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getns","title":"getNs","text":"

\u25b8 getNs(): undefined

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_18","title":"Returns","text":"

undefined

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_19","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getrules","title":"getRules","text":"

\u25b8 getRules(): PolicyRule[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_21","title":"Returns","text":"

PolicyRule[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): (undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_23","title":"Returns","text":"

(undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_24","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_25","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_29","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_26","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_30","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_14","title":"Parameters","text":"Name Type data Partial<ClusterRole>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_27","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_31","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/","title":"Main.K8sApi.ClusterRoleBinding","text":"

@k8slens/extensions / Exports / Main / K8sApi / ClusterRoleBinding

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#class-clusterrolebinding","title":"Class: ClusterRoleBinding","text":"

Main.K8sApi.ClusterRoleBinding

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<ClusterScopedMetadata, void, void>

\u21b3 ClusterRoleBinding

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • roleRef
  • spec
  • status
  • subjects
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getSubjectNames
  • getSubjects
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#constructor","title":"constructor","text":"

\u2022 new ClusterRoleBinding(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb ClusterRoleBindingData"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#overrides","title":"Overrides","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_1","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#metadata","title":"metadata","text":"

\u2022 metadata: ClusterScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_2","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#roleref","title":"roleRef","text":"

\u2022 roleRef: RoleRef

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#spec","title":"spec","text":"

\u2022 spec: void

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_3","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#status","title":"status","text":"

\u2022 Optional status: void

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_4","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#subjects","title":"subjects","text":"

\u2022 Optional subjects: Subject[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#apibase","title":"apiBase","text":"

\u25aa Static apiBase: string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#overrides_1","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_5","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_6","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#kind_1","title":"kind","text":"

\u25aa Static kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#overrides_2","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#namespaced","title":"namespaced","text":"

\u25aa Static namespaced: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#overrides_3","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_13","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_14","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_15","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_16","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getns","title":"getNs","text":"

\u25b8 getNs(): undefined

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_18","title":"Returns","text":"

undefined

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_19","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_21","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): (undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_22","title":"Returns","text":"

(undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getsubjectnames","title":"getSubjectNames","text":"

\u25b8 getSubjectNames(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getsubjects","title":"getSubjects","text":"

\u25b8 getSubjects(): Subject[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_24","title":"Returns","text":"

Subject[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_25","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_26","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_29","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_27","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_30","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_14","title":"Parameters","text":"Name Type data Partial<ClusterRoleBinding>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_28","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_31","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/","title":"Main.K8sApi.ConfigMap","text":"

@k8slens/extensions / Exports / Main / K8sApi / ConfigMap

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#class-configmap","title":"Class: ConfigMap","text":"

Main.K8sApi.ConfigMap

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, void, void>

\u21b3 ConfigMap

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#properties","title":"Properties","text":"
  • apiVersion
  • binaryData
  • data
  • immutable
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getKeys
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#constructor","title":"constructor","text":"

\u2022 new ConfigMap(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb ConfigMapData"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#overrides","title":"Overrides","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#binarydata","title":"binaryData","text":"

\u2022 binaryData: Partial<Record<string, string>>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#data","title":"data","text":"

\u2022 data: Partial<Record<string, string>>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#immutable","title":"immutable","text":"

\u2022 Optional immutable: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_1","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_2","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#spec","title":"spec","text":"

\u2022 spec: void

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_3","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#status","title":"status","text":"

\u2022 Optional status: void

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_4","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#apibase","title":"apiBase","text":"

\u25aa Static apiBase: string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#overrides_1","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_5","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_6","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#kind_1","title":"kind","text":"

\u25aa Static kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#overrides_2","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#namespaced","title":"namespaced","text":"

\u25aa Static namespaced: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#overrides_3","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_13","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_14","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_15","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_16","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getkeys","title":"getKeys","text":"

\u25b8 getKeys(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_17","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_18","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_20","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_21","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_23","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_24","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_25","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_29","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_26","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_30","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_14","title":"Parameters","text":"Name Type data Partial<ConfigMap>"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_27","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_31","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/","title":"Main.K8sApi.CronJob","text":"

@k8slens/extensions / Exports / Main / K8sApi / CronJob

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#class-cronjob","title":"Class: CronJob","text":"

Main.K8sApi.CronJob

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, CronJobStatus, CronJobSpec>

\u21b3 CronJob

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getLabels
  • getLastScheduleTime
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getSchedule
  • getScopedName
  • getSearchFields
  • getSuspendFlag
  • getTimeDiffFromNow
  • isNeverRun
  • isSuspend
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#constructor","title":"constructor","text":"

\u2022 new CronJob(data)

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, CronJobStatus, CronJobSpec>"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#spec","title":"spec","text":"

\u2022 spec: CronJobSpec

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#status","title":"status","text":"

\u2022 Optional status: CronJobStatus

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/apis/batch/v1/cronjobs\"

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"CronJob\"

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getlastscheduletime","title":"getLastScheduleTime","text":"

\u25b8 getLastScheduleTime(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_18","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_20","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_21","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getschedule","title":"getSchedule","text":"

\u25b8 getSchedule(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_24","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getsuspendflag","title":"getSuspendFlag","text":"

\u25b8 getSuspendFlag(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_25","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_26","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#isneverrun","title":"isNeverRun","text":"

\u25b8 isNeverRun(): boolean

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_27","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#issuspend","title":"isSuspend","text":"

\u25b8 isSuspend(): undefined | boolean

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_28","title":"Returns","text":"

undefined | boolean

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_29","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_30","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_14","title":"Parameters","text":"Name Type data Partial<CronJob>"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_31","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/","title":"Main.K8sApi.CustomResourceDefinition","text":"

@k8slens/extensions / Exports / Main / K8sApi / CustomResourceDefinition

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#class-customresourcedefinition","title":"Class: CustomResourceDefinition","text":"

Main.K8sApi.CustomResourceDefinition

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<ClusterScopedMetadata, CustomResourceDefinitionStatus, CustomResourceDefinitionSpec>

\u21b3 CustomResourceDefinition

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getConditions
  • getConversion
  • getCreationTimestamp
  • getFinalizers
  • getGroup
  • getId
  • getLabels
  • getName
  • getNames
  • getNs
  • getOwnerRefs
  • getPluralName
  • getPreferedVersion
  • getPrinterColumns
  • getResourceApiBase
  • getResourceKind
  • getResourceTitle
  • getResourceUrl
  • getResourceVersion
  • getScope
  • getScopedName
  • getSearchFields
  • getStoredVersions
  • getTimeDiffFromNow
  • getValidation
  • getVersion
  • isNamespaced
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#constructor","title":"constructor","text":"

\u2022 new CustomResourceDefinition(data)

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<ClusterScopedMetadata, CustomResourceDefinitionStatus, CustomResourceDefinitionSpec>"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#metadata","title":"metadata","text":"

\u2022 metadata: ClusterScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#spec","title":"spec","text":"

\u2022 spec: CustomResourceDefinitionSpec

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#status","title":"status","text":"

\u2022 Optional status: CustomResourceDefinitionStatus

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#apibase","title":"apiBase","text":"

\u25aa Static apiBase: string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#kind_1","title":"kind","text":"

\u25aa Static kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#namespaced","title":"namespaced","text":"

\u25aa Static namespaced: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getconditions","title":"getConditions","text":"

\u25b8 getConditions(): { isReady: boolean ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: \"True\" | \"False\" | \"Unknown\" ; tooltip: string ; type: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_13","title":"Returns","text":"

{ isReady: boolean ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: \"True\" | \"False\" | \"Unknown\" ; tooltip: string ; type: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getconversion","title":"getConversion","text":"

\u25b8 getConversion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_14","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getgroup","title":"getGroup","text":"

\u25b8 getGroup(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_18","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_19","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getnames","title":"getNames","text":"

\u25b8 getNames(): CustomResourceDefinitionNames

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_21","title":"Returns","text":"

CustomResourceDefinitionNames

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getns","title":"getNs","text":"

\u25b8 getNs(): undefined

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_22","title":"Returns","text":"

undefined

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_23","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getpluralname","title":"getPluralName","text":"

\u25b8 getPluralName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_24","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getpreferedversion","title":"getPreferedVersion","text":"

\u25b8 getPreferedVersion(): CustomResourceDefinitionVersion

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_25","title":"Returns","text":"

CustomResourceDefinitionVersion

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getprintercolumns","title":"getPrinterColumns","text":"

\u25b8 getPrinterColumns(ignorePriority?): AdditionalPrinterColumnsV1[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_13","title":"Parameters","text":"Name Type ignorePriority? boolean"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_26","title":"Returns","text":"

AdditionalPrinterColumnsV1[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getresourceapibase","title":"getResourceApiBase","text":"

\u25b8 getResourceApiBase(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_27","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getresourcekind","title":"getResourceKind","text":"

\u25b8 getResourceKind(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_28","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getresourcetitle","title":"getResourceTitle","text":"

\u25b8 getResourceTitle(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_29","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getresourceurl","title":"getResourceUrl","text":"

\u25b8 getResourceUrl(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_30","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_31","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getscope","title":"getScope","text":"

\u25b8 getScope(): \"Cluster\" | \"Namespaced\"

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_32","title":"Returns","text":"

\"Cluster\" | \"Namespaced\"

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_33","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): (undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_34","title":"Returns","text":"

(undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getstoredversions","title":"getStoredVersions","text":"

\u25b8 getStoredVersions(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_35","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_36","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getvalidation","title":"getValidation","text":"

\u25b8 getValidation(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_37","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getversion","title":"getVersion","text":"

\u25b8 getVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_38","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#isnamespaced","title":"isNamespaced","text":"

\u25b8 isNamespaced(): boolean

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_39","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_14","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_40","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_41","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_15","title":"Parameters","text":"Name Type data Partial<CustomResourceDefinition>"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_42","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/","title":"Main.K8sApi.DaemonSet","text":"

@k8slens/extensions / Exports / Main / K8sApi / DaemonSet

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#class-daemonset","title":"Class: DaemonSet","text":"

Main.K8sApi.DaemonSet

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, DaemonSetStatus, DaemonSetSpec>

\u21b3 DaemonSet

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#methods","title":"Methods","text":"
  • delete
  • getAffinity
  • getAffinityNumber
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getImages
  • getLabels
  • getName
  • getNodeSelectors
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getSelectors
  • getTemplateLabels
  • getTimeDiffFromNow
  • getTolerations
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#constructor","title":"constructor","text":"

\u2022 new DaemonSet(data)

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, DaemonSetStatus, DaemonSetSpec>"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#spec","title":"spec","text":"

\u2022 spec: DaemonSetSpec

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#status","title":"status","text":"

\u2022 Optional status: DaemonSetStatus

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#apibase","title":"apiBase","text":"

\u25aa Static apiBase: string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#kind_1","title":"kind","text":"

\u25aa Static kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#namespaced","title":"namespaced","text":"

\u25aa Static namespaced: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getaffinity","title":"getAffinity","text":"

\u25b8 getAffinity(): undefined | Affinity

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_11","title":"Returns","text":"

undefined | Affinity

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getaffinitynumber","title":"getAffinityNumber","text":"

\u25b8 getAffinityNumber(): number

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_12","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_13","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getimages","title":"getImages","text":"

\u25b8 getImages(): (undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_18","title":"Returns","text":"

(undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_19","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getnodeselectors","title":"getNodeSelectors","text":"

\u25b8 getNodeSelectors(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_21","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_23","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_24","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_25","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_26","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getselectors","title":"getSelectors","text":"

\u25b8 getSelectors(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_27","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#gettemplatelabels","title":"getTemplateLabels","text":"

\u25b8 getTemplateLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_28","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_29","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#gettolerations","title":"getTolerations","text":"

\u25b8 getTolerations(): Toleration[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_30","title":"Returns","text":"

Toleration[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_31","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_32","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_14","title":"Parameters","text":"Name Type data Partial<DaemonSet>"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_33","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/","title":"Main.K8sApi.Deployment","text":"

@k8slens/extensions / Exports / Main / K8sApi / Deployment

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#class-deployment","title":"Class: Deployment","text":"

Main.K8sApi.Deployment

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, DeploymentStatus, DeploymentSpec>

\u21b3 Deployment

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#methods","title":"Methods","text":"
  • delete
  • getAffinity
  • getAffinityNumber
  • getAge
  • getAnnotations
  • getConditions
  • getConditionsText
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getLabels
  • getName
  • getNodeSelectors
  • getNs
  • getOwnerRefs
  • getReplicas
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getSelectors
  • getTemplateLabels
  • getTimeDiffFromNow
  • getTolerations
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#constructor","title":"constructor","text":"

\u2022 new Deployment(data)

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, DeploymentStatus, DeploymentSpec>"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#spec","title":"spec","text":"

\u2022 spec: DeploymentSpec

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#status","title":"status","text":"

\u2022 Optional status: DeploymentStatus

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#apibase","title":"apiBase","text":"

\u25aa Static apiBase: string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#kind_1","title":"kind","text":"

\u25aa Static kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#namespaced","title":"namespaced","text":"

\u25aa Static namespaced: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getaffinity","title":"getAffinity","text":"

\u25b8 getAffinity(): undefined | Affinity

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_11","title":"Returns","text":"

undefined | Affinity

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getaffinitynumber","title":"getAffinityNumber","text":"

\u25b8 getAffinityNumber(): number

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_12","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_13","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getconditions","title":"getConditions","text":"

\u25b8 getConditions(activeOnly?): BaseKubeObjectCondition[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_13","title":"Parameters","text":"Name Type activeOnly? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_15","title":"Returns","text":"

BaseKubeObjectCondition[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getconditionstext","title":"getConditionsText","text":"

\u25b8 getConditionsText(activeOnly?): string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_14","title":"Parameters","text":"Name Type activeOnly? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_16","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_17","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_18","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_20","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_21","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getnodeselectors","title":"getNodeSelectors","text":"

\u25b8 getNodeSelectors(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_22","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_24","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getreplicas","title":"getReplicas","text":"

\u25b8 getReplicas(): number

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_25","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_26","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_27","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_28","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getselectors","title":"getSelectors","text":"

\u25b8 getSelectors(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_29","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#gettemplatelabels","title":"getTemplateLabels","text":"

\u25b8 getTemplateLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_30","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_31","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#gettolerations","title":"getTolerations","text":"

\u25b8 getTolerations(): Toleration[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_32","title":"Returns","text":"

Toleration[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_15","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_33","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_34","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_16","title":"Parameters","text":"Name Type data Partial<Deployment>"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_35","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/","title":"Main.K8sApi.Endpoint","text":"

@k8slens/extensions / Exports / Main / K8sApi / Endpoint

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#class-endpoint","title":"Class: Endpoint","text":"

Main.K8sApi.Endpoint

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, void, void>

\u21b3 Endpoint

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • subsets
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getEndpointSubsets
  • getFinalizers
  • getId
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • toString
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#constructor","title":"constructor","text":"

\u2022 new Endpoint(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb EndpointsData"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#overrides","title":"Overrides","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_1","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_2","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#spec","title":"spec","text":"

\u2022 spec: void

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_3","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#status","title":"status","text":"

\u2022 Optional status: void

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_4","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#subsets","title":"subsets","text":"

\u2022 Optional subsets: EndpointSubset[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#apibase","title":"apiBase","text":"

\u25aa Static apiBase: string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#overrides_1","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_5","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_6","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#kind_1","title":"kind","text":"

\u25aa Static kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#overrides_2","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#namespaced","title":"namespaced","text":"

\u25aa Static namespaced: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#overrides_3","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_13","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_14","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_15","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_16","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getendpointsubsets","title":"getEndpointSubsets","text":"

\u25b8 getEndpointSubsets(): Required<EndpointSubset>[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_14","title":"Returns","text":"

Required<EndpointSubset>[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_15","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_16","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_17","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_18","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_20","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_21","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_23","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_24","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_25","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_29","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_26","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_30","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#tostring","title":"toString","text":"

\u25b8 toString(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_27","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_14","title":"Parameters","text":"Name Type data Partial<Endpoint>"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_28","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_31","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/","title":"Main.K8sApi.HorizontalPodAutoscaler","text":"

@k8slens/extensions / Exports / Main / K8sApi / HorizontalPodAutoscaler

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#class-horizontalpodautoscaler","title":"Class: HorizontalPodAutoscaler","text":"

Main.K8sApi.HorizontalPodAutoscaler

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, HorizontalPodAutoscalerStatus, HorizontalPodAutoscalerSpec>

\u21b3 HorizontalPodAutoscaler

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getConditions
  • getCreationTimestamp
  • getCurrentMetrics
  • getFinalizers
  • getId
  • getLabels
  • getMaxPods
  • getMetrics
  • getMinPods
  • getName
  • getNs
  • getOwnerRefs
  • getReadyConditions
  • getReplicas
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#constructor","title":"constructor","text":"

\u2022 new HorizontalPodAutoscaler(data)

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, HorizontalPodAutoscalerStatus, HorizontalPodAutoscalerSpec>"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#spec","title":"spec","text":"

\u2022 spec: HorizontalPodAutoscalerSpec

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#status","title":"status","text":"

\u2022 Optional status: HorizontalPodAutoscalerStatus

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/apis/autoscaling/v2/horizontalpodautoscalers\"

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"HorizontalPodAutoscaler\"

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getconditions","title":"getConditions","text":"

\u25b8 getConditions(): { isReady: boolean ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: \"True\" | \"False\" | \"Unknown\" ; tooltip: string ; type: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_13","title":"Returns","text":"

{ isReady: boolean ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: \"True\" | \"False\" | \"Unknown\" ; tooltip: string ; type: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getcurrentmetrics","title":"getCurrentMetrics","text":"

\u25b8 getCurrentMetrics(): HorizontalPodAutoscalerMetricStatus[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_15","title":"Returns","text":"

HorizontalPodAutoscalerMetricStatus[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_18","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getmaxpods","title":"getMaxPods","text":"

\u25b8 getMaxPods(): number

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_19","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getmetrics","title":"getMetrics","text":"

\u25b8 getMetrics(): HorizontalPodAutoscalerMetricSpec[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_20","title":"Returns","text":"

HorizontalPodAutoscalerMetricSpec[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getminpods","title":"getMinPods","text":"

\u25b8 getMinPods(): number

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_21","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_24","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getreadyconditions","title":"getReadyConditions","text":"

\u25b8 getReadyConditions(): { isReady: boolean ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: \"True\" | \"False\" | \"Unknown\" ; tooltip: string ; type: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_25","title":"Returns","text":"

{ isReady: boolean ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: \"True\" | \"False\" | \"Unknown\" ; tooltip: string ; type: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getreplicas","title":"getReplicas","text":"

\u25b8 getReplicas(): number

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_26","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_27","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_28","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_29","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_30","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_31","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_32","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_14","title":"Parameters","text":"Name Type data Partial<HorizontalPodAutoscaler>"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_33","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/","title":"Main.K8sApi.Ingress","text":"

@k8slens/extensions / Exports / Main / K8sApi / Ingress

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#class-ingress","title":"Class: Ingress","text":"

Main.K8sApi.Ingress

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, IngressStatus, IngressSpec>

\u21b3 Ingress

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getHosts
  • getId
  • getLabels
  • getLoadBalancers
  • getName
  • getNs
  • getOwnerRefs
  • getPorts
  • getResourceVersion
  • getRoutes
  • getRules
  • getScopedName
  • getSearchFields
  • getServiceNamePort
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#constructor","title":"constructor","text":"

\u2022 new Ingress(data)

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, IngressStatus, IngressSpec>"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#spec","title":"spec","text":"

\u2022 spec: IngressSpec

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#status","title":"status","text":"

\u2022 Optional status: IngressStatus

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/apis/networking.k8s.io/v1/ingresses\"

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"Ingress\"

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#gethosts","title":"getHosts","text":"

\u25b8 getHosts(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_15","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_16","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_17","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getloadbalancers","title":"getLoadBalancers","text":"

\u25b8 getLoadBalancers(): (undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_18","title":"Returns","text":"

(undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_21","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getports","title":"getPorts","text":"

\u25b8 getPorts(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getroutes","title":"getRoutes","text":"

\u25b8 getRoutes(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_24","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getrules","title":"getRules","text":"

\u25b8 getRules(): IngressRule[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_25","title":"Returns","text":"

IngressRule[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_26","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_27","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getservicenameport","title":"getServiceNamePort","text":"

\u25b8 getServiceNamePort(): undefined | ExtensionsBackend

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_28","title":"Returns","text":"

undefined | ExtensionsBackend

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_29","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_30","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_31","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_14","title":"Parameters","text":"Name Type data Partial<Ingress>"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_32","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.Job/","title":"Main.K8sApi.Job","text":"

@k8slens/extensions / Exports / Main / K8sApi / Job

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#class-job","title":"Class: Job","text":"

Main.K8sApi.Job

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, JobStatus, JobSpec>

\u21b3 Job

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.Job/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#methods","title":"Methods","text":"
  • delete
  • getAffinity
  • getAffinityNumber
  • getAge
  • getAnnotations
  • getCompletions
  • getCondition
  • getCreationTimestamp
  • getDesiredCompletions
  • getFinalizers
  • getId
  • getImages
  • getLabels
  • getName
  • getNodeSelectors
  • getNs
  • getOwnerRefs
  • getParallelism
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getSelectors
  • getTemplateLabels
  • getTimeDiffFromNow
  • getTolerations
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Job/#constructor","title":"constructor","text":"

\u2022 new Job(data)

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, JobStatus, JobSpec>"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Job/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#spec","title":"spec","text":"

\u2022 spec: JobSpec

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#status","title":"status","text":"

\u2022 Optional status: JobStatus

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/apis/batch/v1/jobs\"

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Job/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"Job\"

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Job/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Job/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getaffinity","title":"getAffinity","text":"

\u25b8 getAffinity(): undefined | Affinity

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_11","title":"Returns","text":"

undefined | Affinity

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getaffinitynumber","title":"getAffinityNumber","text":"

\u25b8 getAffinityNumber(): number

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_12","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_13","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getcompletions","title":"getCompletions","text":"

\u25b8 getCompletions(): number

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getcondition","title":"getCondition","text":"

\u25b8 getCondition(): undefined | BaseKubeObjectCondition

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_16","title":"Returns","text":"

undefined | BaseKubeObjectCondition

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_17","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getdesiredcompletions","title":"getDesiredCompletions","text":"

\u25b8 getDesiredCompletions(): number

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_18","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_19","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getimages","title":"getImages","text":"

\u25b8 getImages(): (undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_21","title":"Returns","text":"

(undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_22","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getnodeselectors","title":"getNodeSelectors","text":"

\u25b8 getNodeSelectors(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_24","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_25","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_26","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getparallelism","title":"getParallelism","text":"

\u25b8 getParallelism(): undefined | number

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_27","title":"Returns","text":"

undefined | number

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_28","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_29","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_30","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getselectors","title":"getSelectors","text":"

\u25b8 getSelectors(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_31","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#gettemplatelabels","title":"getTemplateLabels","text":"

\u25b8 getTemplateLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_32","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_33","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#gettolerations","title":"getTolerations","text":"

\u25b8 getTolerations(): Toleration[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_34","title":"Returns","text":"

Toleration[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_35","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_36","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_14","title":"Parameters","text":"Name Type data Partial<Job>"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_37","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/","title":"Main.K8sApi.KubeEvent","text":"

@k8slens/extensions / Exports / Main / K8sApi / KubeEvent

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#class-kubeevent","title":"Class: KubeEvent","text":"

Main.K8sApi.KubeEvent

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<KubeObjectMetadata<KubeObjectScope.Namespace>, void, void>

\u21b3 KubeEvent

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#properties","title":"Properties","text":"
  • action
  • apiVersion
  • count
  • eventTime
  • firstTimestamp
  • involvedObject
  • kind
  • lastTimestamp
  • message
  • metadata
  • reason
  • related
  • reportingComponent
  • reportingInstance
  • series
  • source
  • spec
  • status
  • type
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getFirstSeenTime
  • getId
  • getLabels
  • getLastSeenTime
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getSource
  • getTimeDiffFromNow
  • isWarning
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#constructor","title":"constructor","text":"

\u2022 new KubeEvent(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeEventData"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#overrides","title":"Overrides","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#action","title":"action","text":"

\u2022 Optional action: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#count","title":"count","text":"

\u2022 Optional count: number

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#eventtime","title":"eventTime","text":"

\u2022 Optional eventTime: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#firsttimestamp","title":"firstTimestamp","text":"

\u2022 Optional firstTimestamp: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#involvedobject","title":"involvedObject","text":"

\u2022 involvedObject: Required<ObjectReference>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_1","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#lasttimestamp","title":"lastTimestamp","text":"

\u2022 Optional lastTimestamp: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#message","title":"message","text":"

\u2022 Optional message: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#metadata","title":"metadata","text":"

\u2022 metadata: KubeObjectMetadata<Namespace>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_2","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#reason","title":"reason","text":"

\u2022 Optional reason: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#related","title":"related","text":"

\u2022 Optional related: ObjectReference

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#reportingcomponent","title":"reportingComponent","text":"

\u2022 Optional reportingComponent: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#reportinginstance","title":"reportingInstance","text":"

\u2022 Optional reportingInstance: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#series","title":"series","text":"

\u2022 Optional series: EventSeries

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#source","title":"source","text":"

\u2022 Optional source: EventSource

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#spec","title":"spec","text":"

\u2022 spec: void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_3","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#status","title":"status","text":"

\u2022 Optional status: void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_4","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type","title":"type","text":"

\u2022 Optional type: string

Current supported values are: - \"Normal\" - \"Warning\"

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#apibase","title":"apiBase","text":"

\u25aa Static apiBase: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#overrides_1","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_5","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_6","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#kind_1","title":"kind","text":"

\u25aa Static kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#overrides_2","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#namespaced","title":"namespaced","text":"

\u25aa Static namespaced: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#overrides_3","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_13","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_14","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_15","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_16","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getfirstseentime","title":"getFirstSeenTime","text":"

\u25b8 getFirstSeenTime(): string

Deprecated

This function is not reactive to changing of time. If rendering use <ReactiveDuration /> instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_16","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_17","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getlastseentime","title":"getLastSeenTime","text":"

\u25b8 getLastSeenTime(): string

Deprecated

This function is not reactive to changing of time. If rendering use <ReactiveDuration /> instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_18","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_21","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_24","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getsource","title":"getSource","text":"

\u25b8 getSource(): string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_25","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_26","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#iswarning","title":"isWarning","text":"

\u25b8 isWarning(): boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_27","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_28","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_29","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_29","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_30","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_14","title":"Parameters","text":"Name Type data Partial<KubeEvent>"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_30","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_31","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/","title":"Main.K8sApi.KubeObject","text":"

@k8slens/extensions / Exports / Main / K8sApi / KubeObject

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#class-kubeobjectmetadata-status-spec","title":"Class: KubeObject<Metadata, Status, Spec>","text":"

Main.K8sApi.KubeObject

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#hierarchy","title":"Hierarchy","text":"
  • KubeObject

\u21b3 Pod

\u21b3 Node

\u21b3 Deployment

\u21b3 DaemonSet

\u21b3 StatefulSet

\u21b3 Job

\u21b3 CronJob

\u21b3 ConfigMap

\u21b3 Secret

\u21b3 ReplicaSet

\u21b3 ResourceQuota

\u21b3 LimitRange

\u21b3 HorizontalPodAutoscaler

\u21b3 PodDisruptionBudget

\u21b3 PriorityClass

\u21b3 Service

\u21b3 Endpoint

\u21b3 Ingress

\u21b3 NetworkPolicy

\u21b3 PersistentVolume

\u21b3 PersistentVolumeClaim

\u21b3 StorageClass

\u21b3 Namespace

\u21b3 KubeEvent

\u21b3 ServiceAccount

\u21b3 Role

\u21b3 RoleBinding

\u21b3 ClusterRole

\u21b3 ClusterRoleBinding

\u21b3 CustomResourceDefinition

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#constructor","title":"constructor","text":"

\u2022 new KubeObject<Metadata, Status, Spec>(data)

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-parameters_1","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#metadata","title":"metadata","text":"

\u2022 metadata: Metadata

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#spec","title":"spec","text":"

\u2022 spec: Spec

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#status","title":"status","text":"

\u2022 Optional status: Status

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#apibase","title":"apiBase","text":"

\u25aa Static Optional Readonly apiBase: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-parameters_2","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-parameters_3","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#kind_1","title":"kind","text":"

\u25aa Static Optional Readonly kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#namespaced","title":"namespaced","text":"

\u25aa Static Optional Readonly namespaced: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getns","title":"getNs","text":"

\u25b8 getNs(): Metadata[\"namespace\"]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_18","title":"Returns","text":"

Metadata[\"namespace\"]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: Metadata[\"namespace\"] ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_19","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: Metadata[\"namespace\"] ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_21","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): (string | Metadata[\"namespace\"])[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_22","title":"Returns","text":"

(string | Metadata[\"namespace\"])[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_23","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_24","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_25","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_14","title":"Parameters","text":"Name Type data Partial<KubeObject<Metadata, Status, Spec>>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_26","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/","title":"Main.K8sApi.KubeObjectStore","text":"

@k8slens/extensions / Exports / Main / K8sApi / KubeObjectStore

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#class-kubeobjectstorek-a-d","title":"Class: KubeObjectStore<K, A, D>","text":"

Main.K8sApi.KubeObjectStore

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#type-parameters","title":"Type parameters","text":"Name Type K extends KubeObject = KubeObject A extends InternalKubeApi<K, D> = InternalKubeApi<K, KubeJsonApiDataFor<K>> D extends KubeJsonApiDataFor<K> = KubeApiDataFrom<K, A>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<K, A, D>

\u21b3 KubeObjectStore

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
  • context
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#accessors","title":"Accessors","text":"
  • context
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#constructor","title":"constructor","text":"

\u2022 new KubeObjectStore<K, A, D>(api, opts?)

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#type-parameters_1","title":"Type parameters","text":"Name Type K extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, K> = KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> A extends KubeApi<K, D, A> = KubeApi<K, KubeJsonApiDataFor<K>> D extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, D> = KubeApiDataFrom<K, A>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters","title":"Parameters","text":"Name Type api A opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#overrides","title":"Overrides","text":"

InternalKubeObjectStore<K, A, D\\>.constructor

\u2022 new KubeObjectStore<K, A, D>()

Deprecated

Supply API instance through constructor

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#type-parameters_2","title":"Type parameters","text":"Name Type K extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, K> = KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> A extends KubeApi<K, D, A> = KubeApi<K, KubeJsonApiDataFor<K>> D extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, D> = KubeApiDataFrom<K, A>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#overrides_1","title":"Overrides","text":"

InternalKubeObjectStore<K, A, D\\>.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#api","title":"api","text":"

\u2022 Readonly api: A

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from","title":"Inherited from","text":"

InternalKubeObjectStore.api

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_1","title":"Inherited from","text":"

InternalKubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: K) => string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_1","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_2","title":"Inherited from","text":"

InternalKubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_3","title":"Inherited from","text":"

InternalKubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<D>>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_4","title":"Inherited from","text":"

InternalKubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_5","title":"Inherited from","text":"

InternalKubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_6","title":"Inherited from","text":"

InternalKubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_7","title":"Inherited from","text":"

InternalKubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#items","title":"items","text":"

\u2022 items: IObservableArray<K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_8","title":"Inherited from","text":"

InternalKubeObjectStore.items

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_9","title":"Inherited from","text":"

InternalKubeObjectStore.limit

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_10","title":"Inherited from","text":"

InternalKubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#context","title":"context","text":"

\u25aa Static Readonly context: Object

Deprecated

This is no longer used and shouldn't have been every really used

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#type-declaration_1","title":"Type declaration","text":"Name Type get () => ClusterContext set (ctx: ClusterContext) => void"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#context_1","title":"context","text":"

\u2022 get context(): ClusterContext

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_1","title":"Returns","text":"

ClusterContext

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_2","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_11","title":"Inherited from","text":"

InternalKubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_3","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_12","title":"Inherited from","text":"

InternalKubeObjectStore.query

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_4","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_13","title":"Inherited from","text":"

InternalKubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<K, void, undefined>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_5","title":"Returns","text":"

Generator<K, void, undefined>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_14","title":"Inherited from","text":"

InternalKubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_6","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_15","title":"Inherited from","text":"

InternalKubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialDeep<K, {}>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_7","title":"Returns","text":"

Promise<K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_16","title":"Inherited from","text":"

InternalKubeObjectStore.create

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialDeep<K, {}>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_8","title":"Returns","text":"

Promise<null | K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_17","title":"Inherited from","text":"

InternalKubeObjectStore.createItem

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_5","title":"Parameters","text":"Name Type items K[]"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_9","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_18","title":"Inherited from","text":"

InternalKubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_10","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_19","title":"Inherited from","text":"

InternalKubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | K

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_11","title":"Returns","text":"

undefined | K

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_20","title":"Inherited from","text":"

InternalKubeObjectStore.getById

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_12","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_21","title":"Inherited from","text":"

InternalKubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | K

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_13","title":"Returns","text":"

undefined | K

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_22","title":"Inherited from","text":"

InternalKubeObjectStore.getByName

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | K

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_14","title":"Returns","text":"

undefined | K

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_23","title":"Inherited from","text":"

InternalKubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_24","title":"Inherited from","text":"

InternalKubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_16","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_25","title":"Inherited from","text":"

InternalKubeObjectStore.getItems

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_17","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_26","title":"Inherited from","text":"

InternalKubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_12","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_27","title":"Inherited from","text":"

InternalKubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? K[]"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_19","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_28","title":"Inherited from","text":"

InternalKubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#load","title":"load","text":"

\u25b8 load(params): Promise<K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_20","title":"Returns","text":"

Promise<K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_29","title":"Inherited from","text":"

InternalKubeObjectStore.load

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | K[]>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_21","title":"Returns","text":"

Promise<undefined | K[]>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_30","title":"Inherited from","text":"

InternalKubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_22","title":"Returns","text":"

Promise<K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_31","title":"Inherited from","text":"

InternalKubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_23","title":"Returns","text":"

Promise<null | K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_32","title":"Inherited from","text":"

InternalKubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<K[]>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_24","title":"Returns","text":"

Promise<K[]>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_33","title":"Inherited from","text":"

InternalKubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_19","title":"Parameters","text":"Name Type partialItems K[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_25","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_34","title":"Inherited from","text":"

InternalKubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_20","title":"Parameters","text":"Name Type item K patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_26","title":"Returns","text":"

Promise<K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_35","title":"Inherited from","text":"

InternalKubeObjectStore.patch

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_21","title":"Parameters","text":"Name Type items K[]"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_27","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_36","title":"Inherited from","text":"

InternalKubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | K[]>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_28","title":"Returns","text":"

Promise<undefined | K[]>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_37","title":"Inherited from","text":"

InternalKubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_23","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_38","title":"Inherited from","text":"

InternalKubeObjectStore.remove

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_24","title":"Parameters","text":"Name Type item K request () => Promise<any>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_39","title":"Inherited from","text":"

InternalKubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_25","title":"Parameters","text":"Name Type items K[]"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_40","title":"Inherited from","text":"

InternalKubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_32","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_41","title":"Inherited from","text":"

InternalKubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_42","title":"Inherited from","text":"

InternalKubeObjectStore.reset

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_43","title":"Inherited from","text":"

InternalKubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_44","title":"Inherited from","text":"

InternalKubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_27","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_36","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_45","title":"Inherited from","text":"

InternalKubeObjectStore.select

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): K[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_28","title":"Parameters","text":"Name Type Description items? K[] the items to be sorted (default: the current items in this store) sorting? (item: K) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_37","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_46","title":"Inherited from","text":"

InternalKubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_38","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_47","title":"Inherited from","text":"

InternalKubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_30","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_48","title":"Inherited from","text":"

InternalKubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? K[]"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_49","title":"Inherited from","text":"

InternalKubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_32","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_41","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_50","title":"Inherited from","text":"

InternalKubeObjectStore.unselect

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_33","title":"Parameters","text":"Name Type item K data PartialDeep<K, {}>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_42","title":"Returns","text":"

Promise<K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_51","title":"Inherited from","text":"

InternalKubeObjectStore.update

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_43","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_52","title":"Inherited from","text":"

InternalKubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_34","title":"Parameters","text":"Name Type item K request () => Promise<K>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_44","title":"Returns","text":"

Promise<K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_53","title":"Inherited from","text":"

InternalKubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/","title":"Main.K8sApi.KubeStatus","text":"

@k8slens/extensions / Exports / Main / K8sApi / KubeStatus

"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#class-kubestatus","title":"Class: KubeStatus","text":"

Main.K8sApi.KubeStatus

"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#properties","title":"Properties","text":"
  • apiVersion
  • code
  • kind
  • message
  • reason
  • status
"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#methods","title":"Methods","text":"
  • getExplanation
"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#constructor","title":"constructor","text":"

\u2022 new KubeStatus(data)

"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#parameters","title":"Parameters","text":"Name Type data KubeStatusData"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#apiversion","title":"apiVersion","text":"

\u2022 Readonly apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#code","title":"code","text":"

\u2022 Readonly code: number

"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#kind","title":"kind","text":"

\u2022 Readonly kind: \"Status\"

"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#message","title":"message","text":"

\u2022 Readonly message: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#reason","title":"reason","text":"

\u2022 Readonly reason: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#status","title":"status","text":"

\u2022 Readonly status: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#getexplanation","title":"getExplanation","text":"

\u25b8 getExplanation(): string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/","title":"Main.K8sApi.LimitRange","text":"

@k8slens/extensions / Exports / Main / K8sApi / LimitRange

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#class-limitrange","title":"Class: LimitRange","text":"

Main.K8sApi.LimitRange

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, void, LimitRangeSpec>

\u21b3 LimitRange

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getContainerLimits
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getPVCLimits
  • getPodLimits
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#constructor","title":"constructor","text":"

\u2022 new LimitRange(data)

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, void, LimitRangeSpec>"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#spec","title":"spec","text":"

\u2022 spec: LimitRangeSpec

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#status","title":"status","text":"

\u2022 Optional status: void

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/api/v1/limitranges\"

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"LimitRange\"

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getcontainerlimits","title":"getContainerLimits","text":"

\u25b8 getContainerLimits(): LimitRangeItem[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_13","title":"Returns","text":"

LimitRangeItem[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_15","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_16","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_17","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_18","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_20","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getpvclimits","title":"getPVCLimits","text":"

\u25b8 getPVCLimits(): LimitRangeItem[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_21","title":"Returns","text":"

LimitRangeItem[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getpodlimits","title":"getPodLimits","text":"

\u25b8 getPodLimits(): LimitRangeItem[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_22","title":"Returns","text":"

LimitRangeItem[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_24","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_25","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_26","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_27","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_28","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_14","title":"Parameters","text":"Name Type data Partial<LimitRange>"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_29","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/","title":"Main.K8sApi.Namespace","text":"

@k8slens/extensions / Exports / Main / K8sApi / Namespace

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#class-namespace","title":"Class: Namespace","text":"

Main.K8sApi.Namespace

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<ClusterScopedMetadata, NamespaceStatus, NamespaceSpec>

\u21b3 Namespace

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getStatus
  • getTimeDiffFromNow
  • isChildOf
  • isControlledByHNC
  • isSubnamespace
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#constructor","title":"constructor","text":"

\u2022 new Namespace(data)

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<ClusterScopedMetadata, NamespaceStatus, NamespaceSpec>"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#metadata","title":"metadata","text":"

\u2022 metadata: ClusterScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#spec","title":"spec","text":"

\u2022 spec: NamespaceSpec

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#status","title":"status","text":"

\u2022 Optional status: NamespaceStatus

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/api/v1/namespaces\"

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"Namespace\"

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: false

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getns","title":"getNs","text":"

\u25b8 getNs(): undefined

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_18","title":"Returns","text":"

undefined

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_19","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_21","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): (undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_22","title":"Returns","text":"

(undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getstatus","title":"getStatus","text":"

\u25b8 getStatus(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_24","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#ischildof","title":"isChildOf","text":"

\u25b8 isChildOf(parentName): undefined | string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_13","title":"Parameters","text":"Name Type parentName string"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_25","title":"Returns","text":"

undefined | string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#iscontrolledbyhnc","title":"isControlledByHNC","text":"

\u25b8 isControlledByHNC(): boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_26","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#issubnamespace","title":"isSubnamespace","text":"

\u25b8 isSubnamespace(): undefined | string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_27","title":"Returns","text":"

undefined | string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_14","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_28","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_29","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_15","title":"Parameters","text":"Name Type data Partial<Namespace>"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_30","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/","title":"Main.K8sApi.NetworkPolicy","text":"

@k8slens/extensions / Exports / Main / K8sApi / NetworkPolicy

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#class-networkpolicy","title":"Class: NetworkPolicy","text":"

Main.K8sApi.NetworkPolicy

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, void, NetworkPolicySpec>

\u21b3 NetworkPolicy

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getLabels
  • getMatchLabels
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getTimeDiffFromNow
  • getTypes
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#constructor","title":"constructor","text":"

\u2022 new NetworkPolicy(data)

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, void, NetworkPolicySpec>"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#spec","title":"spec","text":"

\u2022 spec: NetworkPolicySpec

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#status","title":"status","text":"

\u2022 Optional status: void

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/apis/networking.k8s.io/v1/networkpolicies\"

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"NetworkPolicy\"

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getmatchlabels","title":"getMatchLabels","text":"

\u25b8 getMatchLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_17","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_18","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_20","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_21","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_23","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_24","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#gettypes","title":"getTypes","text":"

\u25b8 getTypes(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_25","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_26","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_27","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_14","title":"Parameters","text":"Name Type data Partial<NetworkPolicy>"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_28","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.Node/","title":"Main.K8sApi.Node","text":"

@k8slens/extensions / Exports / Main / K8sApi / Node

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#class-node","title":"Class: Node","text":"

Main.K8sApi.Node

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<ClusterScopedMetadata, NodeStatus, NodeSpec>

\u21b3 Node

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.Node/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#methods","title":"Methods","text":"
  • delete
  • getActiveConditions
  • getAge
  • getAnnotations
  • getConditions
  • getCpuCapacity
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getKubeletVersion
  • getLabels
  • getMemoryCapacity
  • getName
  • getNodeConditionText
  • getNs
  • getOperatingSystem
  • getOwnerRefs
  • getResourceVersion
  • getRoleLabelItems
  • getRoleLabels
  • getScopedName
  • getSearchFields
  • getTaints
  • getTimeDiffFromNow
  • getWarningConditions
  • isMasterNode
  • isUnschedulable
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Node/#constructor","title":"constructor","text":"

\u2022 new Node(data)

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<ClusterScopedMetadata, NodeStatus, NodeSpec>"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Node/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#metadata","title":"metadata","text":"

\u2022 metadata: ClusterScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#spec","title":"spec","text":"

\u2022 spec: NodeSpec

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#status","title":"status","text":"

\u2022 Optional status: NodeStatus

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/api/v1/nodes\"

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Node/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"Node\"

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: false

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Node/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Node/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getactiveconditions","title":"getActiveConditions","text":"

\u25b8 getActiveConditions(): NodeCondition[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_11","title":"Returns","text":"

NodeCondition[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_12","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_13","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getconditions","title":"getConditions","text":"

\u25b8 getConditions(): NodeCondition[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_14","title":"Returns","text":"

NodeCondition[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getcpucapacity","title":"getCpuCapacity","text":"

\u25b8 getCpuCapacity(): undefined | number

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_15","title":"Returns","text":"

undefined | number

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_17","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_18","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getkubeletversion","title":"getKubeletVersion","text":"

\u25b8 getKubeletVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_20","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getmemorycapacity","title":"getMemoryCapacity","text":"

\u25b8 getMemoryCapacity(): number

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_21","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getnodeconditiontext","title":"getNodeConditionText","text":"

\u25b8 getNodeConditionText(): string

Returns the concatination of all current condition types which have a status of \"True\"

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getns","title":"getNs","text":"

\u25b8 getNs(): undefined

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_24","title":"Returns","text":"

undefined

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getoperatingsystem","title":"getOperatingSystem","text":"

\u25b8 getOperatingSystem(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_25","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_26","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_27","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getrolelabelitems","title":"getRoleLabelItems","text":"

\u25b8 getRoleLabelItems(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_28","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getrolelabels","title":"getRoleLabels","text":"

\u25b8 getRoleLabels(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_29","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_30","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): (undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_31","title":"Returns","text":"

(undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#gettaints","title":"getTaints","text":"

\u25b8 getTaints(): NodeTaint[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_32","title":"Returns","text":"

NodeTaint[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_33","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getwarningconditions","title":"getWarningConditions","text":"

\u25b8 getWarningConditions(): NodeCondition[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_34","title":"Returns","text":"

NodeCondition[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#ismasternode","title":"isMasterNode","text":"

\u25b8 isMasterNode(): boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_35","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#isunschedulable","title":"isUnschedulable","text":"

\u25b8 isUnschedulable(): undefined | boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_36","title":"Returns","text":"

undefined | boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_37","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_38","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_14","title":"Parameters","text":"Name Type data Partial<Node>"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_39","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/","title":"Main.K8sApi.PersistentVolume","text":"

@k8slens/extensions / Exports / Main / K8sApi / PersistentVolume

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#class-persistentvolume","title":"Class: PersistentVolume","text":"

Main.K8sApi.PersistentVolume

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<ClusterScopedMetadata, PersistentVolumeStatus, PersistentVolumeSpec>

\u21b3 PersistentVolume

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCapacity
  • getClaimRefName
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getStatus
  • getStorageClass
  • getStorageClassName
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#constructor","title":"constructor","text":"

\u2022 new PersistentVolume(data)

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<ClusterScopedMetadata, PersistentVolumeStatus, PersistentVolumeSpec>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#metadata","title":"metadata","text":"

\u2022 metadata: ClusterScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#spec","title":"spec","text":"

\u2022 spec: PersistentVolumeSpec

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#status","title":"status","text":"

\u2022 Optional status: PersistentVolumeStatus

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#apibase","title":"apiBase","text":"

\u25aa Static apiBase: string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#kind_1","title":"kind","text":"

\u25aa Static kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#namespaced","title":"namespaced","text":"

\u25aa Static namespaced: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getcapacity","title":"getCapacity","text":"

\u25b8 getCapacity(inBytes?): string | number

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_13","title":"Parameters","text":"Name Type inBytes? boolean"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_13","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getclaimrefname","title":"getClaimRefName","text":"

\u25b8 getClaimRefName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_14","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_18","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getns","title":"getNs","text":"

\u25b8 getNs(): undefined

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_20","title":"Returns","text":"

undefined

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_21","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): (undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_24","title":"Returns","text":"

(undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getstatus","title":"getStatus","text":"

\u25b8 getStatus(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_25","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getstorageclass","title":"getStorageClass","text":"

\u25b8 getStorageClass(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_26","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getstorageclassname","title":"getStorageClassName","text":"

\u25b8 getStorageClassName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_27","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_28","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_14","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_29","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_30","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_15","title":"Parameters","text":"Name Type data Partial<PersistentVolume>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_31","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/","title":"Main.K8sApi.PersistentVolumeClaim","text":"

@k8slens/extensions / Exports / Main / K8sApi / PersistentVolumeClaim

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#class-persistentvolumeclaim","title":"Class: PersistentVolumeClaim","text":"

Main.K8sApi.PersistentVolumeClaim

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, PersistentVolumeClaimStatus, PersistentVolumeClaimSpec>

\u21b3 PersistentVolumeClaim

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getLabels
  • getMatchExpressions
  • getMatchLabels
  • getName
  • getNs
  • getOwnerRefs
  • getPods
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getStatus
  • getStorage
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#constructor","title":"constructor","text":"

\u2022 new PersistentVolumeClaim(data)

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, PersistentVolumeClaimStatus, PersistentVolumeClaimSpec>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#spec","title":"spec","text":"

\u2022 spec: PersistentVolumeClaimSpec

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#status","title":"status","text":"

\u2022 Optional status: PersistentVolumeClaimStatus

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/api/v1/persistentvolumeclaims\"

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"PersistentVolumeClaim\"

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getmatchexpressions","title":"getMatchExpressions","text":"

\u25b8 getMatchExpressions(): LabelMatchExpression[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_17","title":"Returns","text":"

LabelMatchExpression[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getmatchlabels","title":"getMatchLabels","text":"

\u25b8 getMatchLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_18","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_21","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getpods","title":"getPods","text":"

\u25b8 getPods(pods): Pod[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_13","title":"Parameters","text":"Name Type pods Pod[]"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_22","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_24","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_25","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getstatus","title":"getStatus","text":"

\u25b8 getStatus(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_26","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getstorage","title":"getStorage","text":"

\u25b8 getStorage(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_27","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_28","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_14","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_29","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_30","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_15","title":"Parameters","text":"Name Type data Partial<PersistentVolumeClaim>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_31","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/","title":"Main.K8sApi.Pod","text":"

@k8slens/extensions / Exports / Main / K8sApi / Pod

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#class-pod","title":"Class: Pod","text":"

Main.K8sApi.Pod

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, PodStatus, PodSpec>

\u21b3 Pod

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.Pod/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#methods","title":"Methods","text":"
  • delete
  • getAffinity
  • getAffinityNumber
  • getAge
  • getAllContainers
  • getAnnotations
  • getConditions
  • getContainerStatuses
  • getContainers
  • getCreationTimestamp
  • getFinalizers
  • getIPs
  • getId
  • getInitContainers
  • getLabels
  • getLivenessProbe
  • getName
  • getNodeName
  • getNodeSelectors
  • getNs
  • getOwnerRefs
  • getPriorityClassName
  • getQosClass
  • getReadinessProbe
  • getReason
  • getResourceVersion
  • getRestartsCount
  • getRunningContainers
  • getRuntimeClassName
  • getScopedName
  • getSearchFields
  • getSecrets
  • getSelectedNodeOs
  • getServiceAccountName
  • getStartupProbe
  • getStatus
  • getStatusMessage
  • getStatusPhase
  • getTimeDiffFromNow
  • getTolerations
  • getVolumes
  • hasIssues
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Pod/#constructor","title":"constructor","text":"

\u2022 new Pod(data)

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, PodStatus, PodSpec>"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Pod/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#spec","title":"spec","text":"

\u2022 spec: PodSpec

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#status","title":"status","text":"

\u2022 Optional status: PodStatus

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#apibase","title":"apiBase","text":"

\u25aa Static apiBase: string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#kind_1","title":"kind","text":"

\u25aa Static kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#namespaced","title":"namespaced","text":"

\u25aa Static namespaced: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Pod/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Pod/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getaffinity","title":"getAffinity","text":"

\u25b8 getAffinity(): Affinity

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_11","title":"Returns","text":"

Affinity

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getaffinitynumber","title":"getAffinityNumber","text":"

\u25b8 getAffinityNumber(): number

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_12","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_13","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getallcontainers","title":"getAllContainers","text":"

\u25b8 getAllContainers(): IPodContainer[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_14","title":"Returns","text":"

IPodContainer[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_15","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getconditions","title":"getConditions","text":"

\u25b8 getConditions(): PodCondition[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_16","title":"Returns","text":"

PodCondition[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getcontainerstatuses","title":"getContainerStatuses","text":"

\u25b8 getContainerStatuses(includeInitContainers?): IPodContainerStatus[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_13","title":"Parameters","text":"Name Type includeInitContainers? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_17","title":"Returns","text":"

IPodContainerStatus[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getcontainers","title":"getContainers","text":"

\u25b8 getContainers(): IPodContainer[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_18","title":"Returns","text":"

IPodContainer[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_19","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_20","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getips","title":"getIPs","text":"

\u25b8 getIPs(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_21","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getinitcontainers","title":"getInitContainers","text":"

\u25b8 getInitContainers(): IPodContainer[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_23","title":"Returns","text":"

IPodContainer[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_24","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getlivenessprobe","title":"getLivenessProbe","text":"

\u25b8 getLivenessProbe(container): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_14","title":"Parameters","text":"Name Type container IPodContainer"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_25","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_26","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getnodename","title":"getNodeName","text":"

\u25b8 getNodeName(): undefined | string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_27","title":"Returns","text":"

undefined | string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getnodeselectors","title":"getNodeSelectors","text":"

\u25b8 getNodeSelectors(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_28","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_29","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_30","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getpriorityclassname","title":"getPriorityClassName","text":"

\u25b8 getPriorityClassName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_31","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getqosclass","title":"getQosClass","text":"

\u25b8 getQosClass(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_32","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getreadinessprobe","title":"getReadinessProbe","text":"

\u25b8 getReadinessProbe(container): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_15","title":"Parameters","text":"Name Type container IPodContainer"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_33","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getreason","title":"getReason","text":"

\u25b8 getReason(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_34","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_35","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getrestartscount","title":"getRestartsCount","text":"

\u25b8 getRestartsCount(): number

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_36","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getrunningcontainers","title":"getRunningContainers","text":"

\u25b8 getRunningContainers(): IPodContainer[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_37","title":"Returns","text":"

IPodContainer[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getruntimeclassname","title":"getRuntimeClassName","text":"

\u25b8 getRuntimeClassName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_38","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_39","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_40","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getsecrets","title":"getSecrets","text":"

\u25b8 getSecrets(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_41","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getselectednodeos","title":"getSelectedNodeOs","text":"

\u25b8 getSelectedNodeOs(): undefined | string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_42","title":"Returns","text":"

undefined | string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getserviceaccountname","title":"getServiceAccountName","text":"

\u25b8 getServiceAccountName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_43","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getstartupprobe","title":"getStartupProbe","text":"

\u25b8 getStartupProbe(container): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_16","title":"Parameters","text":"Name Type container IPodContainer"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_44","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getstatus","title":"getStatus","text":"

\u25b8 getStatus(): PodStatusPhase

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_45","title":"Returns","text":"

PodStatusPhase

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getstatusmessage","title":"getStatusMessage","text":"

\u25b8 getStatusMessage(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_46","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getstatusphase","title":"getStatusPhase","text":"

\u25b8 getStatusPhase(): undefined | string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_47","title":"Returns","text":"

undefined | string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_48","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#gettolerations","title":"getTolerations","text":"

\u25b8 getTolerations(): Toleration[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_49","title":"Returns","text":"

Toleration[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getvolumes","title":"getVolumes","text":"

\u25b8 getVolumes(): PodSpecVolume[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_50","title":"Returns","text":"

PodSpecVolume[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#hasissues","title":"hasIssues","text":"

\u25b8 hasIssues(): boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_51","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_17","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_52","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_53","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_18","title":"Parameters","text":"Name Type data Partial<Pod>"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_54","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/","title":"Main.K8sApi.PodDisruptionBudget","text":"

@k8slens/extensions / Exports / Main / K8sApi / PodDisruptionBudget

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#class-poddisruptionbudget","title":"Class: PodDisruptionBudget","text":"

Main.K8sApi.PodDisruptionBudget

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, PodDisruptionBudgetStatus, PodDisruptionBudgetSpec>

\u21b3 PodDisruptionBudget

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getCurrentHealthy
  • getDesiredHealthy
  • getFinalizers
  • getId
  • getLabels
  • getMaxUnavailable
  • getMinAvailable
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getSelectors
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#constructor","title":"constructor","text":"

\u2022 new PodDisruptionBudget(data)

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, PodDisruptionBudgetStatus, PodDisruptionBudgetSpec>"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#spec","title":"spec","text":"

\u2022 spec: PodDisruptionBudgetSpec

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#status","title":"status","text":"

\u2022 Optional status: PodDisruptionBudgetStatus

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/apis/policy/v1beta1/poddisruptionbudgets\"

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"PodDisruptionBudget\"

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getcurrenthealthy","title":"getCurrentHealthy","text":"

\u25b8 getCurrentHealthy(): number

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getdesiredhealthy","title":"getDesiredHealthy","text":"

\u25b8 getDesiredHealthy(): number

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_18","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getmaxunavailable","title":"getMaxUnavailable","text":"

\u25b8 getMaxUnavailable(): string | number

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_19","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getminavailable","title":"getMinAvailable","text":"

\u25b8 getMinAvailable(): string | number

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_20","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_21","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_23","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_24","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_25","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_26","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getselectors","title":"getSelectors","text":"

\u25b8 getSelectors(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_27","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_28","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_29","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_30","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_14","title":"Parameters","text":"Name Type data Partial<PodDisruptionBudget>"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_31","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/","title":"Main.K8sApi.PriorityClass","text":"

@k8slens/extensions / Exports / Main / K8sApi / PriorityClass

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#class-priorityclass","title":"Class: PriorityClass","text":"

Main.K8sApi.PriorityClass

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<ClusterScopedMetadata, void, void>

\u21b3 PriorityClass

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#properties","title":"Properties","text":"
  • apiVersion
  • description
  • globalDefault
  • kind
  • metadata
  • preemptionPolicy
  • spec
  • status
  • value
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getDescription
  • getFinalizers
  • getGlobalDefault
  • getId
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getPreemptionPolicy
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getTimeDiffFromNow
  • getValue
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#constructor","title":"constructor","text":"

\u2022 new PriorityClass(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb PriorityClassData"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#overrides","title":"Overrides","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#description","title":"description","text":"

\u2022 Optional description: string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#globaldefault","title":"globalDefault","text":"

\u2022 Optional globalDefault: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_1","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#metadata","title":"metadata","text":"

\u2022 metadata: ClusterScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_2","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#preemptionpolicy","title":"preemptionPolicy","text":"

\u2022 Optional preemptionPolicy: PreemptionPolicy

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#spec","title":"spec","text":"

\u2022 spec: void

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_3","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#status","title":"status","text":"

\u2022 Optional status: void

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_4","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#value","title":"value","text":"

\u2022 Optional value: number

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/apis/scheduling.k8s.io/v1/priorityclasses\"

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#overrides_1","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_5","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_6","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"PriorityClass\"

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#overrides_2","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: false

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#overrides_3","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_13","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_14","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_15","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_16","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getdescription","title":"getDescription","text":"

\u25b8 getDescription(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_14","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_15","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getglobaldefault","title":"getGlobalDefault","text":"

\u25b8 getGlobalDefault(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_16","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_18","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getns","title":"getNs","text":"

\u25b8 getNs(): undefined

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_20","title":"Returns","text":"

undefined

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_21","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getpreemptionpolicy","title":"getPreemptionPolicy","text":"

\u25b8 getPreemptionPolicy(): PreemptionPolicy

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_22","title":"Returns","text":"

PreemptionPolicy

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_24","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): (undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_25","title":"Returns","text":"

(undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_26","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getvalue","title":"getValue","text":"

\u25b8 getValue(): undefined | number

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_27","title":"Returns","text":"

undefined | number

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_28","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_29","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_29","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_30","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_14","title":"Parameters","text":"Name Type data Partial<PriorityClass>"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_30","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_31","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/","title":"Main.K8sApi.ReplicaSet","text":"

@k8slens/extensions / Exports / Main / K8sApi / ReplicaSet

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#class-replicaset","title":"Class: ReplicaSet","text":"

Main.K8sApi.ReplicaSet

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, ReplicaSetStatus, ReplicaSetSpec>

\u21b3 ReplicaSet

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#methods","title":"Methods","text":"
  • delete
  • getAffinity
  • getAffinityNumber
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getCurrent
  • getDesired
  • getFinalizers
  • getId
  • getImages
  • getLabels
  • getName
  • getNodeSelectors
  • getNs
  • getOwnerRefs
  • getReady
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getSelectors
  • getTemplateLabels
  • getTimeDiffFromNow
  • getTolerations
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#constructor","title":"constructor","text":"

\u2022 new ReplicaSet(data)

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, ReplicaSetStatus, ReplicaSetSpec>"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#spec","title":"spec","text":"

\u2022 spec: ReplicaSetSpec

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#status","title":"status","text":"

\u2022 Optional status: ReplicaSetStatus

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#apibase","title":"apiBase","text":"

\u25aa Static apiBase: string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#kind_1","title":"kind","text":"

\u25aa Static kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#namespaced","title":"namespaced","text":"

\u25aa Static namespaced: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getaffinity","title":"getAffinity","text":"

\u25b8 getAffinity(): undefined | Affinity

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_11","title":"Returns","text":"

undefined | Affinity

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getaffinitynumber","title":"getAffinityNumber","text":"

\u25b8 getAffinityNumber(): number

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_12","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_13","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getcurrent","title":"getCurrent","text":"

\u25b8 getCurrent(): number

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getdesired","title":"getDesired","text":"

\u25b8 getDesired(): number

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_17","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_18","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getimages","title":"getImages","text":"

\u25b8 getImages(): (undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_20","title":"Returns","text":"

(undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_21","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getnodeselectors","title":"getNodeSelectors","text":"

\u25b8 getNodeSelectors(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_23","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_24","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_25","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getready","title":"getReady","text":"

\u25b8 getReady(): number

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_26","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_27","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_28","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_29","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getselectors","title":"getSelectors","text":"

\u25b8 getSelectors(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_30","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#gettemplatelabels","title":"getTemplateLabels","text":"

\u25b8 getTemplateLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_31","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_32","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#gettolerations","title":"getTolerations","text":"

\u25b8 getTolerations(): Toleration[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_33","title":"Returns","text":"

Toleration[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_34","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_35","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_14","title":"Parameters","text":"Name Type data Partial<ReplicaSet>"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_36","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/","title":"Main.K8sApi.ResourceQuota","text":"

@k8slens/extensions / Exports / Main / K8sApi / ResourceQuota

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#class-resourcequota","title":"Class: ResourceQuota","text":"

Main.K8sApi.ResourceQuota

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, ResourceQuotaStatus, ResourceQuotaSpec>

\u21b3 ResourceQuota

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getScopeSelector
  • getScopedName
  • getSearchFields
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#constructor","title":"constructor","text":"

\u2022 new ResourceQuota(data)

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, ResourceQuotaStatus, ResourceQuotaSpec>"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#spec","title":"spec","text":"

\u2022 spec: ResourceQuotaSpec

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#status","title":"status","text":"

\u2022 Optional status: ResourceQuotaStatus

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/api/v1/resourcequotas\"

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"ResourceQuota\"

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_18","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_19","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getscopeselector","title":"getScopeSelector","text":"

\u25b8 getScopeSelector(): { operator: string ; scopeName: string ; values: string[] }[]

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_21","title":"Returns","text":"

{ operator: string ; scopeName: string ; values: string[] }[]

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_23","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_24","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_25","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_26","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_14","title":"Parameters","text":"Name Type data Partial<ResourceQuota>"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_27","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/","title":"Main.K8sApi.ResourceStack","text":"

@k8slens/extensions / Exports / Main / K8sApi / ResourceStack

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#class-resourcestack","title":"Class: ResourceStack","text":"

Main.K8sApi.ResourceStack

Deprecated

Switch to using Common.createResourceStack instead

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#implements","title":"Implements","text":"
  • ResourceApplyingStack
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#methods","title":"Methods","text":"
  • kubectlApplyFolder
  • kubectlDeleteFolder
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#constructor","title":"constructor","text":"

\u2022 new ResourceStack(cluster, name)

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#parameters","title":"Parameters","text":"Name Type cluster KubernetesCluster<KubernetesClusterMetadata, KubernetesClusterStatus, KubernetesClusterSpec> name string"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#kubectlapplyfolder","title":"kubectlApplyFolder","text":"

\u25b8 kubectlApplyFolder(folderPath, templateContext?, extraArgs?): Promise<string>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#parameters_1","title":"Parameters","text":"Name Type folderPath string templateContext? any extraArgs? string[]"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#returns","title":"Returns","text":"

Promise<string>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#implementation-of","title":"Implementation of","text":"

ResourceApplyingStack.kubectlApplyFolder

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#kubectldeletefolder","title":"kubectlDeleteFolder","text":"

\u25b8 kubectlDeleteFolder(folderPath, templateContext?, extraArgs?): Promise<string>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#parameters_2","title":"Parameters","text":"Name Type folderPath string templateContext? any extraArgs? string[]"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#returns_1","title":"Returns","text":"

Promise<string>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#implementation-of_1","title":"Implementation of","text":"

ResourceApplyingStack.kubectlDeleteFolder

"},{"location":"extensions/api/classes/Main.K8sApi.Role/","title":"Main.K8sApi.Role","text":"

@k8slens/extensions / Exports / Main / K8sApi / Role

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#class-role","title":"Class: Role","text":"

Main.K8sApi.Role

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, void, void>

\u21b3 Role

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.Role/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • rules
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getRules
  • getScopedName
  • getSearchFields
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Role/#constructor","title":"constructor","text":"

\u2022 new Role(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb RoleData"},{"location":"extensions/api/classes/Main.K8sApi.Role/#overrides","title":"Overrides","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Role/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_1","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_2","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#rules","title":"rules","text":"

\u2022 Optional rules: PolicyRule[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#spec","title":"spec","text":"

\u2022 spec: void

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_3","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#status","title":"status","text":"

\u2022 Optional status: void

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_4","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/apis/rbac.authorization.k8s.io/v1/roles\"

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#overrides_1","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_5","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_6","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Role/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"Role\"

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#overrides_2","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#overrides_3","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_13","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Role/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_14","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Role/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_15","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_16","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_18","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_19","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getrules","title":"getRules","text":"

\u25b8 getRules(): PolicyRule[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_21","title":"Returns","text":"

PolicyRule[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_23","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_24","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_25","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_29","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_26","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_30","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_14","title":"Parameters","text":"Name Type data Partial<Role>"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_27","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_31","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/","title":"Main.K8sApi.RoleBinding","text":"

@k8slens/extensions / Exports / Main / K8sApi / RoleBinding

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#class-rolebinding","title":"Class: RoleBinding","text":"

Main.K8sApi.RoleBinding

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, void, void>

\u21b3 RoleBinding

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • roleRef
  • spec
  • status
  • subjects
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getSubjectNames
  • getSubjects
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#constructor","title":"constructor","text":"

\u2022 new RoleBinding(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb RoleBindingData"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#overrides","title":"Overrides","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_1","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_2","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#roleref","title":"roleRef","text":"

\u2022 roleRef: RoleRef

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#spec","title":"spec","text":"

\u2022 spec: void

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_3","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#status","title":"status","text":"

\u2022 Optional status: void

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_4","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#subjects","title":"subjects","text":"

\u2022 Optional subjects: Subject[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/apis/rbac.authorization.k8s.io/v1/rolebindings\"

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#overrides_1","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_5","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_6","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"RoleBinding\"

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#overrides_2","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#overrides_3","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_13","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_14","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_15","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_16","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_18","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_19","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_21","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_22","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getsubjectnames","title":"getSubjectNames","text":"

\u25b8 getSubjectNames(): string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getsubjects","title":"getSubjects","text":"

\u25b8 getSubjects(): Subject[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_24","title":"Returns","text":"

Subject[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_25","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_26","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_29","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_27","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_30","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_14","title":"Parameters","text":"Name Type data Partial<RoleBinding>"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_28","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_31","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/","title":"Main.K8sApi.Secret","text":"

@k8slens/extensions / Exports / Main / K8sApi / Secret

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#class-secret","title":"Class: Secret","text":"

Main.K8sApi.Secret

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, void, void>

\u21b3 Secret

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.Secret/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#properties","title":"Properties","text":"
  • apiVersion
  • data
  • kind
  • metadata
  • spec
  • status
  • type
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getKeys
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getTimeDiffFromNow
  • getToken
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Secret/#constructor","title":"constructor","text":"

\u2022 new Secret(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb SecretData"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#overrides","title":"Overrides","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Secret/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#data","title":"data","text":"

\u2022 data: Partial<Record<string, string>>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_1","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_2","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#spec","title":"spec","text":"

\u2022 spec: void

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_3","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#status","title":"status","text":"

\u2022 Optional status: void

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_4","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type","title":"type","text":"

\u2022 type: SecretType

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/api/v1/secrets\"

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#overrides_1","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_5","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_6","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"Secret\"

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#overrides_2","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#overrides_3","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_13","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Secret/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_14","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Secret/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_15","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_16","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getkeys","title":"getKeys","text":"

\u25b8 getKeys(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_17","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_18","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_20","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_21","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_23","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_24","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#gettoken","title":"getToken","text":"

\u25b8 getToken(): undefined | string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_25","title":"Returns","text":"

undefined | string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_26","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_29","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_27","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_30","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_14","title":"Parameters","text":"Name Type data Partial<Secret>"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_28","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_31","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.Service/","title":"Main.K8sApi.Service","text":"

@k8slens/extensions / Exports / Main / K8sApi / Service

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#class-service","title":"Class: Service","text":"

Main.K8sApi.Service

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, ServiceStatus, ServiceSpec>

\u21b3 Service

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.Service/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getClusterIp
  • getClusterIps
  • getCreationTimestamp
  • getExternalIps
  • getFinalizers
  • getId
  • getIpFamilies
  • getIpFamilyPolicy
  • getLabels
  • getLoadBalancer
  • getName
  • getNs
  • getOwnerRefs
  • getPorts
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getSelector
  • getStatus
  • getTimeDiffFromNow
  • getType
  • isActive
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Service/#constructor","title":"constructor","text":"

\u2022 new Service(data)

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, ServiceStatus, ServiceSpec>"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Service/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#spec","title":"spec","text":"

\u2022 spec: ServiceSpec

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#status","title":"status","text":"

\u2022 Optional status: ServiceStatus

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/api/v1/services\"

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Service/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"Service\"

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Service/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Service/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getclusterip","title":"getClusterIp","text":"

\u25b8 getClusterIp(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_13","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getclusterips","title":"getClusterIps","text":"

\u25b8 getClusterIps(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getexternalips","title":"getExternalIps","text":"

\u25b8 getExternalIps(): (undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_16","title":"Returns","text":"

(undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_17","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_18","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getipfamilies","title":"getIpFamilies","text":"

\u25b8 getIpFamilies(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_19","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getipfamilypolicy","title":"getIpFamilyPolicy","text":"

\u25b8 getIpFamilyPolicy(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_21","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getloadbalancer","title":"getLoadBalancer","text":"

\u25b8 getLoadBalancer(): undefined | { ingress?: { hostname?: string ; ip?: string }[] }

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_22","title":"Returns","text":"

undefined | { ingress?: { hostname?: string ; ip?: string }[] }

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_24","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_25","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getports","title":"getPorts","text":"

\u25b8 getPorts(): ServicePort[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_26","title":"Returns","text":"

ServicePort[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_27","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_28","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_29","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getselector","title":"getSelector","text":"

\u25b8 getSelector(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_30","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getstatus","title":"getStatus","text":"

\u25b8 getStatus(): \"Active\" | \"Pending\"

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_31","title":"Returns","text":"

\"Active\" | \"Pending\"

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_32","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#gettype","title":"getType","text":"

\u25b8 getType(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_33","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#isactive","title":"isActive","text":"

\u25b8 isActive(): boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_34","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_35","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_36","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_14","title":"Parameters","text":"Name Type data Partial<Service>"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_37","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/","title":"Main.K8sApi.ServiceAccount","text":"

@k8slens/extensions / Exports / Main / K8sApi / ServiceAccount

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#class-serviceaccount","title":"Class: ServiceAccount","text":"

Main.K8sApi.ServiceAccount

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, void, void>

\u21b3 ServiceAccount

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#properties","title":"Properties","text":"
  • apiVersion
  • automountServiceAccountToken
  • imagePullSecrets
  • kind
  • metadata
  • secrets
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getImagePullSecrets
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getSecrets
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#constructor","title":"constructor","text":"

\u2022 new ServiceAccount(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb ServiceAccountData"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#overrides","title":"Overrides","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#automountserviceaccounttoken","title":"automountServiceAccountToken","text":"

\u2022 Optional automountServiceAccountToken: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#imagepullsecrets","title":"imagePullSecrets","text":"

\u2022 Optional imagePullSecrets: LocalObjectReference[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_1","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_2","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#secrets","title":"secrets","text":"

\u2022 Optional secrets: ObjectReference[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#spec","title":"spec","text":"

\u2022 spec: void

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_3","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#status","title":"status","text":"

\u2022 Optional status: void

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_4","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/api/v1/serviceaccounts\"

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#overrides_1","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_5","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_6","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"ServiceAccount\"

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#overrides_2","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#overrides_3","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_13","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_14","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_15","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_16","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getimagepullsecrets","title":"getImagePullSecrets","text":"

\u25b8 getImagePullSecrets(): LocalObjectReference[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_16","title":"Returns","text":"

LocalObjectReference[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_17","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_18","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_20","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_21","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_23","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getsecrets","title":"getSecrets","text":"

\u25b8 getSecrets(): ObjectReference[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_24","title":"Returns","text":"

ObjectReference[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_25","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_26","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_29","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_27","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_30","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_14","title":"Parameters","text":"Name Type data Partial<ServiceAccount>"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_28","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_31","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/","title":"Main.K8sApi.StatefulSet","text":"

@k8slens/extensions / Exports / Main / K8sApi / StatefulSet

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#class-statefulset","title":"Class: StatefulSet","text":"

Main.K8sApi.StatefulSet

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, StatefulSetStatus, StatefulSetSpec>

\u21b3 StatefulSet

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#methods","title":"Methods","text":"
  • delete
  • getAffinity
  • getAffinityNumber
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getImages
  • getLabels
  • getName
  • getNodeSelectors
  • getNs
  • getOwnerRefs
  • getReplicas
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getSelectors
  • getTemplateLabels
  • getTimeDiffFromNow
  • getTolerations
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#constructor","title":"constructor","text":"

\u2022 new StatefulSet(data)

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, StatefulSetStatus, StatefulSetSpec>"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#spec","title":"spec","text":"

\u2022 spec: StatefulSetSpec

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#status","title":"status","text":"

\u2022 Optional status: StatefulSetStatus

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/apis/apps/v1/statefulsets\"

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"StatefulSet\"

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getaffinity","title":"getAffinity","text":"

\u25b8 getAffinity(): Affinity

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_11","title":"Returns","text":"

Affinity

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getaffinitynumber","title":"getAffinityNumber","text":"

\u25b8 getAffinityNumber(): number

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_12","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_13","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getimages","title":"getImages","text":"

\u25b8 getImages(): (undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_18","title":"Returns","text":"

(undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_19","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getnodeselectors","title":"getNodeSelectors","text":"

\u25b8 getNodeSelectors(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_21","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_23","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getreplicas","title":"getReplicas","text":"

\u25b8 getReplicas(): number

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_24","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_25","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_26","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_27","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getselectors","title":"getSelectors","text":"

\u25b8 getSelectors(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_28","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#gettemplatelabels","title":"getTemplateLabels","text":"

\u25b8 getTemplateLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_29","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_30","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#gettolerations","title":"getTolerations","text":"

\u25b8 getTolerations(): Toleration[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_31","title":"Returns","text":"

Toleration[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_32","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_33","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_14","title":"Parameters","text":"Name Type data Partial<StatefulSet>"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_34","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/","title":"Main.K8sApi.StorageClass","text":"

@k8slens/extensions / Exports / Main / K8sApi / StorageClass

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#class-storageclass","title":"Class: StorageClass","text":"

Main.K8sApi.StorageClass

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<ClusterScopedMetadata, void, void>

\u21b3 StorageClass

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#properties","title":"Properties","text":"
  • allowVolumeExpansion
  • allowedTopologies
  • apiVersion
  • kind
  • metadata
  • mountOptions
  • parameters
  • provisioner
  • reclaimPolicy
  • spec
  • status
  • volumeBindingMode
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getReclaimPolicy
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getTimeDiffFromNow
  • getVolumeBindingMode
  • isDefault
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#constructor","title":"constructor","text":"

\u2022 new StorageClass(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb StorageClassData"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#overrides","title":"Overrides","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#allowvolumeexpansion","title":"allowVolumeExpansion","text":"

\u2022 Optional allowVolumeExpansion: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#allowedtopologies","title":"allowedTopologies","text":"

\u2022 allowedTopologies: TopologySelectorTerm[]

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_1","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#metadata","title":"metadata","text":"

\u2022 metadata: ClusterScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_2","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#mountoptions","title":"mountOptions","text":"

\u2022 mountOptions: string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_1","title":"parameters","text":"

\u2022 parameters: Partial<Record<string, string>>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#provisioner","title":"provisioner","text":"

\u2022 provisioner: string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#reclaimpolicy","title":"reclaimPolicy","text":"

\u2022 reclaimPolicy: string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#spec","title":"spec","text":"

\u2022 spec: void

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_3","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#status","title":"status","text":"

\u2022 Optional status: void

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_4","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#volumebindingmode","title":"volumeBindingMode","text":"

\u2022 Optional volumeBindingMode: string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/apis/storage.k8s.io/v1/storageclasses\"

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#overrides_1","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_2","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_5","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_3","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_6","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_4","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_6","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_7","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_9","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"StorageClass\"

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#overrides_2","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: false

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#overrides_3","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_10","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_13","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_14","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_11","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_15","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_12","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_16","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_13","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getns","title":"getNs","text":"

\u25b8 getNs(): undefined

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_18","title":"Returns","text":"

undefined

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_19","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getreclaimpolicy","title":"getReclaimPolicy","text":"

\u25b8 getReclaimPolicy(): string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_21","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): (undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_23","title":"Returns","text":"

(undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_24","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getvolumebindingmode","title":"getVolumeBindingMode","text":"

\u25b8 getVolumeBindingMode(): string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_25","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#isdefault","title":"isDefault","text":"

\u25b8 isDefault(): boolean

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_26","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_14","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_27","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_29","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_28","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_30","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_15","title":"Parameters","text":"Name Type data Partial<StorageClass>"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_29","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_31","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.LensExtension/","title":"Main.LensExtension","text":"

@k8slens/extensions / Exports / Main / LensExtension

"},{"location":"extensions/api/classes/Main.LensExtension/#class-lensextension","title":"Class: LensExtension","text":"

Main.LensExtension

"},{"location":"extensions/api/classes/Main.LensExtension/#hierarchy","title":"Hierarchy","text":"
  • LensExtension

\u21b3 LensExtension

"},{"location":"extensions/api/classes/Main.LensExtension/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.LensExtension/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.LensExtension/#properties","title":"Properties","text":"
  • appMenus
  • id
  • isBundled
  • manifest
  • manifestPath
  • protocolHandlers
  • terminalShellEnvModifier
  • trayMenus
"},{"location":"extensions/api/classes/Main.LensExtension/#accessors","title":"Accessors","text":"
  • description
  • isEnabled
  • name
  • sanitizedExtensionId
  • storeName
  • version
"},{"location":"extensions/api/classes/Main.LensExtension/#methods","title":"Methods","text":"
  • activate
  • addCatalogSource
  • disable
  • enable
  • getExtensionFileFolder
  • navigate
  • onActivate
  • onDeactivate
  • removeCatalogSource
"},{"location":"extensions/api/classes/Main.LensExtension/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.LensExtension/#constructor","title":"constructor","text":"

\u2022 new LensExtension(extension)

"},{"location":"extensions/api/classes/Main.LensExtension/#parameters","title":"Parameters","text":"Name Type extension InstalledExtension"},{"location":"extensions/api/classes/Main.LensExtension/#overrides","title":"Overrides","text":"

LensExtension.constructor

"},{"location":"extensions/api/classes/Main.LensExtension/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.LensExtension/#appmenus","title":"appMenus","text":"

\u2022 appMenus: MenuRegistration[] | IComputedValue<MenuRegistration[]>

"},{"location":"extensions/api/classes/Main.LensExtension/#id","title":"id","text":"

\u2022 Readonly id: string

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from","title":"Inherited from","text":"

LensExtension.id

"},{"location":"extensions/api/classes/Main.LensExtension/#isbundled","title":"isBundled","text":"

\u2022 Readonly isBundled: boolean

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_1","title":"Inherited from","text":"

LensExtension.isBundled

"},{"location":"extensions/api/classes/Main.LensExtension/#manifest","title":"manifest","text":"

\u2022 Readonly manifest: LensExtensionManifest

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_2","title":"Inherited from","text":"

LensExtension.manifest

"},{"location":"extensions/api/classes/Main.LensExtension/#manifestpath","title":"manifestPath","text":"

\u2022 Readonly manifestPath: string

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_3","title":"Inherited from","text":"

LensExtension.manifestPath

"},{"location":"extensions/api/classes/Main.LensExtension/#protocolhandlers","title":"protocolHandlers","text":"

\u2022 protocolHandlers: ProtocolHandlerRegistration[]

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_4","title":"Inherited from","text":"

LensExtension.protocolHandlers

"},{"location":"extensions/api/classes/Main.LensExtension/#terminalshellenvmodifier","title":"terminalShellEnvModifier","text":"

\u2022 Optional terminalShellEnvModifier: ShellEnvModifier

implement this to modify the shell environment that Lens terminals are opened with. The ShellEnvModifier type has the signature

(ctx: ShellEnvContext, env: Record) => Record

Param

the shell environment context, specifically the relevant catalog entity for the terminal. This can be used, for example, to get cluster-specific information that can be made available in the shell environment by the implementation of terminalShellEnvModifier

Param

the current shell environment that the terminal will be opened with. The implementation should modify this as desired.

"},{"location":"extensions/api/classes/Main.LensExtension/#traymenus","title":"trayMenus","text":"

\u2022 trayMenus: TrayMenuRegistration[] | IComputedValue<TrayMenuRegistration[]>

"},{"location":"extensions/api/classes/Main.LensExtension/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.LensExtension/#description","title":"description","text":"

\u2022 get description(): undefined | string

"},{"location":"extensions/api/classes/Main.LensExtension/#returns","title":"Returns","text":"

undefined | string

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_5","title":"Inherited from","text":"

LensExtension.description

"},{"location":"extensions/api/classes/Main.LensExtension/#isenabled","title":"isEnabled","text":"

\u2022 get isEnabled(): boolean

"},{"location":"extensions/api/classes/Main.LensExtension/#returns_1","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_6","title":"Inherited from","text":"

LensExtension.isEnabled

"},{"location":"extensions/api/classes/Main.LensExtension/#name","title":"name","text":"

\u2022 get name(): string

"},{"location":"extensions/api/classes/Main.LensExtension/#returns_2","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_7","title":"Inherited from","text":"

LensExtension.name

"},{"location":"extensions/api/classes/Main.LensExtension/#sanitizedextensionid","title":"sanitizedExtensionId","text":"

\u2022 get sanitizedExtensionId(): string

"},{"location":"extensions/api/classes/Main.LensExtension/#returns_3","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_8","title":"Inherited from","text":"

LensExtension.sanitizedExtensionId

"},{"location":"extensions/api/classes/Main.LensExtension/#storename","title":"storeName","text":"

\u2022 get storeName(): string

"},{"location":"extensions/api/classes/Main.LensExtension/#returns_4","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_9","title":"Inherited from","text":"

LensExtension.storeName

"},{"location":"extensions/api/classes/Main.LensExtension/#version","title":"version","text":"

\u2022 get version(): string

"},{"location":"extensions/api/classes/Main.LensExtension/#returns_5","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_10","title":"Inherited from","text":"

LensExtension.version

"},{"location":"extensions/api/classes/Main.LensExtension/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.LensExtension/#activate","title":"activate","text":"

\u25b8 activate(): Promise<void>

"},{"location":"extensions/api/classes/Main.LensExtension/#returns_6","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_11","title":"Inherited from","text":"

LensExtension.activate

"},{"location":"extensions/api/classes/Main.LensExtension/#addcatalogsource","title":"addCatalogSource","text":"

\u25b8 addCatalogSource(id, source): void

"},{"location":"extensions/api/classes/Main.LensExtension/#parameters_1","title":"Parameters","text":"Name Type id string source IObservableArray<CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>> | IComputedValue<CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>[]>"},{"location":"extensions/api/classes/Main.LensExtension/#returns_7","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.LensExtension/#disable","title":"disable","text":"

\u25b8 disable(): Promise<void>

"},{"location":"extensions/api/classes/Main.LensExtension/#returns_8","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_12","title":"Inherited from","text":"

LensExtension.disable

"},{"location":"extensions/api/classes/Main.LensExtension/#enable","title":"enable","text":"

\u25b8 enable(): Promise<void>

"},{"location":"extensions/api/classes/Main.LensExtension/#returns_9","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_13","title":"Inherited from","text":"

LensExtension.enable

"},{"location":"extensions/api/classes/Main.LensExtension/#getextensionfilefolder","title":"getExtensionFileFolder","text":"

\u25b8 getExtensionFileFolder(): Promise<string>

getExtensionFileFolder returns the path to an already created folder. This folder is for the sole use of this extension.

Note: there is no security done on this folder, only obfuscation of the folder name.

"},{"location":"extensions/api/classes/Main.LensExtension/#returns_10","title":"Returns","text":"

Promise<string>

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_14","title":"Inherited from","text":"

LensExtension.getExtensionFileFolder

"},{"location":"extensions/api/classes/Main.LensExtension/#navigate","title":"navigate","text":"

\u25b8 navigate(pageId?, params?, frameId?): Promise<void>

"},{"location":"extensions/api/classes/Main.LensExtension/#parameters_2","title":"Parameters","text":"Name Type pageId? string params? Record<string, any> frameId? number"},{"location":"extensions/api/classes/Main.LensExtension/#returns_11","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Main.LensExtension/#onactivate","title":"onActivate","text":"

\u25b8 Protected onActivate(): void | Promise<void>

"},{"location":"extensions/api/classes/Main.LensExtension/#returns_12","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_15","title":"Inherited from","text":"

LensExtension.onActivate

"},{"location":"extensions/api/classes/Main.LensExtension/#ondeactivate","title":"onDeactivate","text":"

\u25b8 Protected onDeactivate(): void | Promise<void>

"},{"location":"extensions/api/classes/Main.LensExtension/#returns_13","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_16","title":"Inherited from","text":"

LensExtension.onDeactivate

"},{"location":"extensions/api/classes/Main.LensExtension/#removecatalogsource","title":"removeCatalogSource","text":"

\u25b8 removeCatalogSource(id): void

"},{"location":"extensions/api/classes/Main.LensExtension/#parameters_3","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Main.LensExtension/#returns_14","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/","title":"Renderer.Catalog.CatalogEntityRegistry","text":"

@k8slens/extensions / Exports / Renderer / Catalog / CatalogEntityRegistry

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#class-catalogentityregistry","title":"Class: CatalogEntityRegistry","text":"

Renderer.Catalog.CatalogEntityRegistry

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#accessors","title":"Accessors","text":"
  • activeEntity
  • entities
"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#methods","title":"Methods","text":"
  • addOnBeforeRun
  • getById
  • getItemsForApiKind
  • getItemsForCategory
"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#constructor","title":"constructor","text":"

\u2022 new CatalogEntityRegistry()

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#activeentity","title":"activeEntity","text":"

\u2022 get activeEntity(): undefined | CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>

Currently active/visible entity

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#returns","title":"Returns","text":"

undefined | CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#entities","title":"entities","text":"

\u2022 get entities(): Map<string, CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>>

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#returns_1","title":"Returns","text":"

Map<string, CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>>

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#addonbeforerun","title":"addOnBeforeRun","text":"

\u25b8 addOnBeforeRun(onBeforeRun): Disposer

Add a onBeforeRun hook to a catalog entities. If onBeforeRun was previously added then it will not be added again.

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#parameters","title":"Parameters","text":"Name Type Description onBeforeRun CatalogEntityOnBeforeRun The function to be called with a CatalogRunEvent event target will be the catalog entity. onBeforeRun hook can call event.preventDefault() to stop run sequence"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#returns_2","title":"Returns","text":"

Disposer

A function to remove that hook

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#parameters_1","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#returns_3","title":"Returns","text":"

undefined | CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#getitemsforapikind","title":"getItemsForApiKind","text":"

\u25b8 getItemsForApiKind<T>(apiVersion, kind): T[]

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#type-parameters","title":"Type parameters","text":"Name Type T extends CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec, T>"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#parameters_2","title":"Parameters","text":"Name Type apiVersion string kind string"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#returns_4","title":"Returns","text":"

T[]

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#getitemsforcategory","title":"getItemsForCategory","text":"

\u25b8 getItemsForCategory<T>(category): T[]

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#type-parameters_1","title":"Type parameters","text":"Name Type T extends CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec, T>"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#parameters_3","title":"Parameters","text":"Name Type category CatalogCategory"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#returns_5","title":"Returns","text":"

T[]

"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/","title":"Renderer.Component.DrawerParamToggler","text":"

@k8slens/extensions / Exports / Renderer / Component / DrawerParamToggler

"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#class-drawerparamtoggler","title":"Class: DrawerParamToggler","text":"

Renderer.Component.DrawerParamToggler

"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#hierarchy","title":"Hierarchy","text":"
  • Component<DrawerParamTogglerProps, State>

\u21b3 DrawerParamToggler

"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#properties","title":"Properties","text":"
  • state
  • toggle
"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#methods","title":"Methods","text":"
  • render
"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#constructor","title":"constructor","text":"

\u2022 new DrawerParamToggler(props)

"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#parameters","title":"Parameters","text":"Name Type props DrawerParamTogglerProps | Readonly<DrawerParamTogglerProps>"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#inherited-from","title":"Inherited from","text":"

React.Component<DrawerParamTogglerProps, State>.constructor

\u2022 new DrawerParamToggler(props, context)

Deprecated

See

https://legacy.reactjs.org/docs/legacy-context.html

"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#parameters_1","title":"Parameters","text":"Name Type props DrawerParamTogglerProps context any"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#inherited-from_1","title":"Inherited from","text":"

React.Component<DrawerParamTogglerProps, State>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#state","title":"state","text":"

\u2022 state: State

"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#overrides","title":"Overrides","text":"

React.Component.state

"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#toggle","title":"toggle","text":"

\u2022 toggle: () => void

"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#type-declaration","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#returns_1","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#overrides_1","title":"Overrides","text":"

React.Component.render

"},{"location":"extensions/api/classes/Renderer.Component.Input/","title":"Renderer.Component.Input","text":"

@k8slens/extensions / Exports / Renderer / Component / Input

"},{"location":"extensions/api/classes/Renderer.Component.Input/#class-input","title":"Class: Input","text":"

Renderer.Component.Input

"},{"location":"extensions/api/classes/Renderer.Component.Input/#hierarchy","title":"Hierarchy","text":"
  • Component<InputProps, State>

\u21b3 Input

"},{"location":"extensions/api/classes/Renderer.Component.Input/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.Input/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.Input/#properties","title":"Properties","text":"
  • input
  • setDirtyOnChange
  • state
  • validators
  • defaultProps
"},{"location":"extensions/api/classes/Renderer.Component.Input/#accessors","title":"Accessors","text":"
  • isUncontrolled
  • showMaxLenIndicator
  • themeSelection
"},{"location":"extensions/api/classes/Renderer.Component.Input/#methods","title":"Methods","text":"
  • bindRef
  • blur
  • componentDidMount
  • componentDidUpdate
  • componentWillUnmount
  • focus
  • getValue
  • onBlur
  • onChange
  • onFocus
  • onKeyDown
  • render
  • select
  • setDirty
  • setValidation
  • setValue
  • validate
"},{"location":"extensions/api/classes/Renderer.Component.Input/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.Input/#constructor","title":"constructor","text":"

\u2022 new Input(props)

"},{"location":"extensions/api/classes/Renderer.Component.Input/#parameters","title":"Parameters","text":"Name Type props InputProps"},{"location":"extensions/api/classes/Renderer.Component.Input/#overrides","title":"Overrides","text":"

React.Component<InputProps, State\\>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.Input/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.Input/#input","title":"input","text":"

\u2022 input: null | InputElement

"},{"location":"extensions/api/classes/Renderer.Component.Input/#setdirtyonchange","title":"setDirtyOnChange","text":"

\u2022 setDirtyOnChange: DebouncedFunc<() => void>

"},{"location":"extensions/api/classes/Renderer.Component.Input/#state","title":"state","text":"

\u2022 state: State

"},{"location":"extensions/api/classes/Renderer.Component.Input/#overrides_1","title":"Overrides","text":"

React.Component.state

"},{"location":"extensions/api/classes/Renderer.Component.Input/#validators","title":"validators","text":"

\u2022 validators: InputValidator<boolean>[]

"},{"location":"extensions/api/classes/Renderer.Component.Input/#defaultprops","title":"defaultProps","text":"

\u25aa Static defaultProps: object

"},{"location":"extensions/api/classes/Renderer.Component.Input/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.Component.Input/#isuncontrolled","title":"isUncontrolled","text":"

\u2022 get isUncontrolled(): boolean

"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.Component.Input/#showmaxlenindicator","title":"showMaxLenIndicator","text":"

\u2022 get showMaxLenIndicator(): undefined | boolean | 0

"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_1","title":"Returns","text":"

undefined | boolean | 0

"},{"location":"extensions/api/classes/Renderer.Component.Input/#themeselection","title":"themeSelection","text":"

\u2022 get themeSelection(): Record<string, boolean>

"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_2","title":"Returns","text":"

Record<string, boolean>

"},{"location":"extensions/api/classes/Renderer.Component.Input/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.Input/#bindref","title":"bindRef","text":"

\u25b8 bindRef(elem): void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#parameters_1","title":"Parameters","text":"Name Type elem InputElement"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#blur","title":"blur","text":"

\u25b8 blur(): void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_4","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#componentdidmount","title":"componentDidMount","text":"

\u25b8 componentDidMount(): void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#overrides_2","title":"Overrides","text":"

React.Component.componentDidMount

"},{"location":"extensions/api/classes/Renderer.Component.Input/#componentdidupdate","title":"componentDidUpdate","text":"

\u25b8 componentDidUpdate(prevProps): void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#parameters_2","title":"Parameters","text":"Name Type prevProps InputProps"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_6","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#overrides_3","title":"Overrides","text":"

React.Component.componentDidUpdate

"},{"location":"extensions/api/classes/Renderer.Component.Input/#componentwillunmount","title":"componentWillUnmount","text":"

\u25b8 componentWillUnmount(): void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_7","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#overrides_4","title":"Overrides","text":"

React.Component.componentWillUnmount

"},{"location":"extensions/api/classes/Renderer.Component.Input/#focus","title":"focus","text":"

\u25b8 focus(): void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_8","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#getvalue","title":"getValue","text":"

\u25b8 getValue(): string

"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.Component.Input/#onblur","title":"onBlur","text":"

\u25b8 onBlur(evt): void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#parameters_3","title":"Parameters","text":"Name Type evt FocusEvent<InputElement, Element>"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#onchange","title":"onChange","text":"

\u25b8 onChange(evt): Promise<void>

"},{"location":"extensions/api/classes/Renderer.Component.Input/#parameters_4","title":"Parameters","text":"Name Type evt ChangeEvent<any>"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_11","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.Component.Input/#onfocus","title":"onFocus","text":"

\u25b8 onFocus(evt): void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#parameters_5","title":"Parameters","text":"Name Type evt FocusEvent<InputElement, Element>"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_12","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#onkeydown","title":"onKeyDown","text":"

\u25b8 onKeyDown(evt): void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#parameters_6","title":"Parameters","text":"Name Type evt KeyboardEvent<InputElement>"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_13","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_14","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.Input/#overrides_5","title":"Overrides","text":"

React.Component.render

"},{"location":"extensions/api/classes/Renderer.Component.Input/#select","title":"select","text":"

\u25b8 select(): void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_15","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#setdirty","title":"setDirty","text":"

\u25b8 setDirty(dirty?): void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#parameters_7","title":"Parameters","text":"Name Type dirty? boolean"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_16","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#setvalidation","title":"setValidation","text":"

\u25b8 setValidation(errors): void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#parameters_8","title":"Parameters","text":"Name Type errors ReactNode[]"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_17","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#setvalue","title":"setValue","text":"

\u25b8 setValue(value?): void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#parameters_9","title":"Parameters","text":"Name Type value? string"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_18","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#validate","title":"validate","text":"

\u25b8 validate(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_19","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/","title":"Renderer.Component.MenuItem","text":"

@k8slens/extensions / Exports / Renderer / Component / MenuItem

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#class-menuitem","title":"Class: MenuItem","text":"

Renderer.Component.MenuItem

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#hierarchy","title":"Hierarchy","text":"
  • Component<MenuItemProps>

\u21b3 MenuItem

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#properties","title":"Properties","text":"
  • context
  • elem
  • contextType
  • defaultProps
"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#accessors","title":"Accessors","text":"
  • isFocusable
  • isLink
"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#methods","title":"Methods","text":"
  • bindRef
  • onClick
  • render
"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#constructor","title":"constructor","text":"

\u2022 new MenuItem(props)

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#parameters","title":"Parameters","text":"Name Type props MenuItemProps"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#overrides","title":"Overrides","text":"

React.Component<MenuItemProps\\>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#context","title":"context","text":"

\u2022 context: MenuContextValue

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#overrides_1","title":"Overrides","text":"

React.Component.context

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#elem","title":"elem","text":"

\u2022 elem: null | HTMLElement

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#contexttype","title":"contextType","text":"

\u25aa Static contextType: Context<null | MenuContextValue>

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#overrides_2","title":"Overrides","text":"

React.Component.contextType

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#defaultprops","title":"defaultProps","text":"

\u25aa Static defaultProps: object

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#isfocusable","title":"isFocusable","text":"

\u2022 get isFocusable(): boolean

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#returns","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#islink","title":"isLink","text":"

\u2022 get isLink(): boolean

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#returns_1","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#bindref","title":"bindRef","text":"

\u25b8 Protected bindRef(elem): void

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#parameters_1","title":"Parameters","text":"Name Type elem HTMLElement"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#onclick","title":"onClick","text":"

\u25b8 onClick(evt): void

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#parameters_2","title":"Parameters","text":"Name Type evt MouseEvent<Element, MouseEvent>"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#returns_4","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#overrides_3","title":"Overrides","text":"

React.Component.render

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/","title":"Renderer.Component.NotificationsStore","text":"

@k8slens/extensions / Exports / Renderer / Component / NotificationsStore

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#class-notificationsstore","title":"Class: NotificationsStore","text":"

Renderer.Component.NotificationsStore

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#properties","title":"Properties","text":"
  • autoHideTimers
  • notifications
"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#methods","title":"Methods","text":"
  • add
  • addAutoHideTimer
  • getById
  • remove
  • removeAutoHideTimer
"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#constructor","title":"constructor","text":"

\u2022 new NotificationsStore()

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#autohidetimers","title":"autoHideTimers","text":"

\u2022 Protected autoHideTimers: Map<NotificationId, number>

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#notifications","title":"notifications","text":"

\u2022 notifications: IObservableArray<{ id: NotificationId ; message: NotificationMessage ; onClose?: () => void ; status?: NotificationStatus ; timeout?: number }>

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#add","title":"add","text":"

\u25b8 add(rawNotification): () => void

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#parameters","title":"Parameters","text":"Name Type rawNotification Notification"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#returns","title":"Returns","text":"

fn

\u25b8 (): void

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#addautohidetimer","title":"addAutoHideTimer","text":"

\u25b8 addAutoHideTimer(id): void

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#parameters_1","title":"Parameters","text":"Name Type id NotificationId"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | { id: NotificationId ; message: NotificationMessage ; onClose?: () => void ; status?: NotificationStatus ; timeout?: number }

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#parameters_2","title":"Parameters","text":"Name Type id NotificationId"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#returns_3","title":"Returns","text":"

undefined | { id: NotificationId ; message: NotificationMessage ; onClose?: () => void ; status?: NotificationStatus ; timeout?: number }

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#remove","title":"remove","text":"

\u25b8 remove(id): void

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#parameters_3","title":"Parameters","text":"Name Type id NotificationId"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#returns_4","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#removeautohidetimer","title":"removeAutoHideTimer","text":"

\u25b8 removeAutoHideTimer(id): void

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#parameters_4","title":"Parameters","text":"Name Type id NotificationId"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/","title":"Renderer.Component.PageLayout","text":"

@k8slens/extensions / Exports / Renderer / Component / PageLayout

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#class-pagelayout","title":"Class: PageLayout","text":"

Renderer.Component.PageLayout

PageLayout is deprecated. See MainLayout & SettingLayout

Deprecated

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#hierarchy","title":"Hierarchy","text":"
  • SettingLayout

\u21b3 PageLayout

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#properties","title":"Properties","text":"
  • onEscapeKey
  • defaultProps
"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#methods","title":"Methods","text":"
  • componentDidMount
  • componentWillUnmount
  • render
"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#constructor","title":"constructor","text":"

\u2022 new PageLayout(props)

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#parameters","title":"Parameters","text":"Name Type props SettingLayoutProps | Readonly<SettingLayoutProps>"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#inherited-from","title":"Inherited from","text":"

SettingLayout.constructor

\u2022 new PageLayout(props, context)

Deprecated

See

https://legacy.reactjs.org/docs/legacy-context.html

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#parameters_1","title":"Parameters","text":"Name Type props SettingLayoutProps context any"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#inherited-from_1","title":"Inherited from","text":"

SettingLayout.constructor

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#onescapekey","title":"onEscapeKey","text":"

\u2022 onEscapeKey: (evt: KeyboardEvent) => void

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#type-declaration","title":"Type declaration","text":"

\u25b8 (evt): void

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#parameters_2","title":"Parameters","text":"Name Type evt KeyboardEvent"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#inherited-from_2","title":"Inherited from","text":"

SettingLayout.onEscapeKey

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#defaultprops","title":"defaultProps","text":"

\u25aa Static defaultProps: object

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#inherited-from_3","title":"Inherited from","text":"

SettingLayout.defaultProps

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#componentdidmount","title":"componentDidMount","text":"

\u25b8 componentDidMount(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#returns_1","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#inherited-from_4","title":"Inherited from","text":"

SettingLayout.componentDidMount

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#componentwillunmount","title":"componentWillUnmount","text":"

\u25b8 componentWillUnmount(): void

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#inherited-from_5","title":"Inherited from","text":"

SettingLayout.componentWillUnmount

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#returns_3","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#inherited-from_6","title":"Inherited from","text":"

SettingLayout.render

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/","title":"Renderer.Component.SettingLayout","text":"

@k8slens/extensions / Exports / Renderer / Component / SettingLayout

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#class-settinglayout","title":"Class: SettingLayout","text":"

Renderer.Component.SettingLayout

Layout for settings like pages with navigation

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#hierarchy","title":"Hierarchy","text":"
  • Component<SettingLayoutProps>

\u21b3 SettingLayout

\u21b3\u21b3 PageLayout

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#properties","title":"Properties","text":"
  • onEscapeKey
  • defaultProps
"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#methods","title":"Methods","text":"
  • componentDidMount
  • componentWillUnmount
  • render
"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#constructor","title":"constructor","text":"

\u2022 new SettingLayout(props)

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#parameters","title":"Parameters","text":"Name Type props SettingLayoutProps | Readonly<SettingLayoutProps>"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#inherited-from","title":"Inherited from","text":"

React.Component<SettingLayoutProps>.constructor

\u2022 new SettingLayout(props, context)

Deprecated

See

https://legacy.reactjs.org/docs/legacy-context.html

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#parameters_1","title":"Parameters","text":"Name Type props SettingLayoutProps context any"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#inherited-from_1","title":"Inherited from","text":"

React.Component<SettingLayoutProps>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#onescapekey","title":"onEscapeKey","text":"

\u2022 onEscapeKey: (evt: KeyboardEvent) => void

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#type-declaration","title":"Type declaration","text":"

\u25b8 (evt): void

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#parameters_2","title":"Parameters","text":"Name Type evt KeyboardEvent"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#defaultprops","title":"defaultProps","text":"

\u25aa Static defaultProps: object

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#componentdidmount","title":"componentDidMount","text":"

\u25b8 componentDidMount(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#returns_1","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#overrides","title":"Overrides","text":"

React.Component.componentDidMount

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#componentwillunmount","title":"componentWillUnmount","text":"

\u25b8 componentWillUnmount(): void

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#overrides_1","title":"Overrides","text":"

React.Component.componentWillUnmount

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#returns_3","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#overrides_2","title":"Overrides","text":"

React.Component.render

"},{"location":"extensions/api/classes/Renderer.Component.Slider/","title":"Renderer.Component.Slider","text":"

@k8slens/extensions / Exports / Renderer / Component / Slider

"},{"location":"extensions/api/classes/Renderer.Component.Slider/#class-slider","title":"Class: Slider","text":"

Renderer.Component.Slider

"},{"location":"extensions/api/classes/Renderer.Component.Slider/#hierarchy","title":"Hierarchy","text":"
  • Component<SliderProps>

\u21b3 Slider

"},{"location":"extensions/api/classes/Renderer.Component.Slider/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.Slider/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.Slider/#properties","title":"Properties","text":"
  • defaultProps
"},{"location":"extensions/api/classes/Renderer.Component.Slider/#methods","title":"Methods","text":"
  • render
"},{"location":"extensions/api/classes/Renderer.Component.Slider/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.Slider/#constructor","title":"constructor","text":"

\u2022 new Slider(props)

"},{"location":"extensions/api/classes/Renderer.Component.Slider/#parameters","title":"Parameters","text":"Name Type props SliderProps | Readonly<SliderProps>"},{"location":"extensions/api/classes/Renderer.Component.Slider/#inherited-from","title":"Inherited from","text":"

Component<SliderProps>.constructor

\u2022 new Slider(props, context)

Deprecated

See

https://legacy.reactjs.org/docs/legacy-context.html

"},{"location":"extensions/api/classes/Renderer.Component.Slider/#parameters_1","title":"Parameters","text":"Name Type props SliderProps context any"},{"location":"extensions/api/classes/Renderer.Component.Slider/#inherited-from_1","title":"Inherited from","text":"

Component<SliderProps>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.Slider/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.Slider/#defaultprops","title":"defaultProps","text":"

\u25aa Static defaultProps: object

"},{"location":"extensions/api/classes/Renderer.Component.Slider/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.Slider/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.Slider/#returns","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.Slider/#overrides","title":"Overrides","text":"

Component.render

"},{"location":"extensions/api/classes/Renderer.Component.Spinner/","title":"Renderer.Component.Spinner","text":"

@k8slens/extensions / Exports / Renderer / Component / Spinner

"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#class-spinner","title":"Class: Spinner","text":"

Renderer.Component.Spinner

"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#hierarchy","title":"Hierarchy","text":"
  • Component<SpinnerProps, {}>

\u21b3 Spinner

"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.Spinner/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#properties","title":"Properties","text":"
  • defaultProps
"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#methods","title":"Methods","text":"
  • render
"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.Spinner/#constructor","title":"constructor","text":"

\u2022 new Spinner(props)

"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#parameters","title":"Parameters","text":"Name Type props SpinnerProps | Readonly<SpinnerProps>"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#inherited-from","title":"Inherited from","text":"

React.Component<SpinnerProps, {}>.constructor

\u2022 new Spinner(props, context)

Deprecated

See

https://legacy.reactjs.org/docs/legacy-context.html

"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#parameters_1","title":"Parameters","text":"Name Type props SpinnerProps context any"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#inherited-from_1","title":"Inherited from","text":"

React.Component<SpinnerProps, {}>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.Spinner/#defaultprops","title":"defaultProps","text":"

\u25aa Static defaultProps: Object

"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#type-declaration","title":"Type declaration","text":"Name Type center boolean singleColor boolean"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.Spinner/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#returns","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#overrides","title":"Overrides","text":"

React.Component.render

"},{"location":"extensions/api/classes/Renderer.Component.Stepper/","title":"Renderer.Component.Stepper","text":"

@k8slens/extensions / Exports / Renderer / Component / Stepper

"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#class-stepper","title":"Class: Stepper","text":"

Renderer.Component.Stepper

"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#hierarchy","title":"Hierarchy","text":"
  • Component<StepperProps, {}>

\u21b3 Stepper

"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.Stepper/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#methods","title":"Methods","text":"
  • render
"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.Stepper/#constructor","title":"constructor","text":"

\u2022 new Stepper(props)

"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#parameters","title":"Parameters","text":"Name Type props StepperProps | Readonly<StepperProps>"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#inherited-from","title":"Inherited from","text":"

React.Component<StepperProps, {}>.constructor

\u2022 new Stepper(props, context)

Deprecated

See

https://legacy.reactjs.org/docs/legacy-context.html

"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#parameters_1","title":"Parameters","text":"Name Type props StepperProps context any"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#inherited-from_1","title":"Inherited from","text":"

React.Component<StepperProps, {}>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.Stepper/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#returns","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#overrides","title":"Overrides","text":"

React.Component.render

"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/","title":"Renderer.Component.SubTitle","text":"

@k8slens/extensions / Exports / Renderer / Component / SubTitle

"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#class-subtitle","title":"Class: SubTitle","text":"

Renderer.Component.SubTitle

"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#hierarchy","title":"Hierarchy","text":"
  • Component<SubTitleProps>

\u21b3 SubTitle

"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#methods","title":"Methods","text":"
  • render
"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#constructor","title":"constructor","text":"

\u2022 new SubTitle(props)

"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#parameters","title":"Parameters","text":"Name Type props SubTitleProps | Readonly<SubTitleProps>"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#inherited-from","title":"Inherited from","text":"

React.Component<SubTitleProps>.constructor

\u2022 new SubTitle(props, context)

Deprecated

See

https://legacy.reactjs.org/docs/legacy-context.html

"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#parameters_1","title":"Parameters","text":"Name Type props SubTitleProps context any"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#inherited-from_1","title":"Inherited from","text":"

React.Component<SubTitleProps>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#returns","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#overrides","title":"Overrides","text":"

React.Component.render

"},{"location":"extensions/api/classes/Renderer.Component.Tab/","title":"Renderer.Component.Tab","text":"

@k8slens/extensions / Exports / Renderer / Component / Tab

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#class-tabd","title":"Class: Tab<D>","text":"

Renderer.Component.Tab

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#type-parameters","title":"Type parameters","text":"Name D"},{"location":"extensions/api/classes/Renderer.Component.Tab/#hierarchy","title":"Hierarchy","text":"
  • PureComponent<TabProps<D>>

\u21b3 Tab

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.Tab/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.Tab/#properties","title":"Properties","text":"
  • context
  • ref
  • contextType
"},{"location":"extensions/api/classes/Renderer.Component.Tab/#accessors","title":"Accessors","text":"
  • isActive
"},{"location":"extensions/api/classes/Renderer.Component.Tab/#methods","title":"Methods","text":"
  • componentDidMount
  • focus
  • onClick
  • onFocus
  • onKeyDown
  • render
  • scrollIntoView
"},{"location":"extensions/api/classes/Renderer.Component.Tab/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.Tab/#constructor","title":"constructor","text":"

\u2022 new Tab<D>(props)

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#type-parameters_1","title":"Type parameters","text":"Name D"},{"location":"extensions/api/classes/Renderer.Component.Tab/#parameters","title":"Parameters","text":"Name Type props TabProps<D>"},{"location":"extensions/api/classes/Renderer.Component.Tab/#overrides","title":"Overrides","text":"

React.PureComponent<TabProps<D\\>\\>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.Tab/#context","title":"context","text":"

\u2022 context: TabsContextValue<D>

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#overrides_1","title":"Overrides","text":"

React.PureComponent.context

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#ref","title":"ref","text":"

\u2022 ref: RefObject<HTMLDivElement>

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#contexttype","title":"contextType","text":"

\u25aa Static contextType: Context<TabsContextValue<unknown>>

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#overrides_2","title":"Overrides","text":"

React.PureComponent.contextType

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.Component.Tab/#isactive","title":"isActive","text":"

\u2022 get isActive(): boolean

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#returns","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.Tab/#componentdidmount","title":"componentDidMount","text":"

\u25b8 componentDidMount(): void

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#overrides_3","title":"Overrides","text":"

React.PureComponent.componentDidMount

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#focus","title":"focus","text":"

\u25b8 focus(): void

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#onclick","title":"onClick","text":"

\u25b8 onClick(evt): void

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#parameters_1","title":"Parameters","text":"Name Type evt MouseEvent<HTMLElement, MouseEvent>"},{"location":"extensions/api/classes/Renderer.Component.Tab/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#onfocus","title":"onFocus","text":"

\u25b8 onFocus(evt): void

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#parameters_2","title":"Parameters","text":"Name Type evt FocusEvent<HTMLElement, Element>"},{"location":"extensions/api/classes/Renderer.Component.Tab/#returns_4","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#onkeydown","title":"onKeyDown","text":"

\u25b8 onKeyDown(evt): void

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#parameters_3","title":"Parameters","text":"Name Type evt KeyboardEvent<HTMLElement>"},{"location":"extensions/api/classes/Renderer.Component.Tab/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#returns_6","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#overrides_4","title":"Overrides","text":"

React.PureComponent.render

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#scrollintoview","title":"scrollIntoView","text":"

\u25b8 scrollIntoView(): void

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#returns_7","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.TableCell/","title":"Renderer.Component.TableCell","text":"

@k8slens/extensions / Exports / Renderer / Component / TableCell

"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#class-tablecell","title":"Class: TableCell","text":"

Renderer.Component.TableCell

"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#hierarchy","title":"Hierarchy","text":"
  • Component<TableCellProps>

\u21b3 TableCell

"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.TableCell/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#methods","title":"Methods","text":"
  • onClick
  • render
  • renderCheckbox
  • renderSortIcon
"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.TableCell/#constructor","title":"constructor","text":"

\u2022 new TableCell(props)

"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#parameters","title":"Parameters","text":"Name Type props TableCellProps"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#overrides","title":"Overrides","text":"

React.Component<TableCellProps\\>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.TableCell/#onclick","title":"onClick","text":"

\u25b8 onClick(evt): void

"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#parameters_1","title":"Parameters","text":"Name Type evt MouseEvent<HTMLDivElement, MouseEvent>"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#returns_1","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#overrides_1","title":"Overrides","text":"

React.Component.render

"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#rendercheckbox","title":"renderCheckbox","text":"

\u25b8 renderCheckbox(): null | Element

"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#returns_2","title":"Returns","text":"

null | Element

"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#rendersorticon","title":"renderSortIcon","text":"

\u25b8 renderSortIcon(): null | Element

"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#returns_3","title":"Returns","text":"

null | Element

"},{"location":"extensions/api/classes/Renderer.Component.TableHead/","title":"Renderer.Component.TableHead","text":"

@k8slens/extensions / Exports / Renderer / Component / TableHead

"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#class-tablehead","title":"Class: TableHead","text":"

Renderer.Component.TableHead

"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#hierarchy","title":"Hierarchy","text":"
  • Component<TableHeadProps>

\u21b3 TableHead

"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.TableHead/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#properties","title":"Properties","text":"
  • defaultProps
"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#methods","title":"Methods","text":"
  • render
"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.TableHead/#constructor","title":"constructor","text":"

\u2022 new TableHead(props)

"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#parameters","title":"Parameters","text":"Name Type props TableHeadProps | Readonly<TableHeadProps>"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#inherited-from","title":"Inherited from","text":"

React.Component<TableHeadProps>.constructor

\u2022 new TableHead(props, context)

Deprecated

See

https://legacy.reactjs.org/docs/legacy-context.html

"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#parameters_1","title":"Parameters","text":"Name Type props TableHeadProps context any"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#inherited-from_1","title":"Inherited from","text":"

React.Component<TableHeadProps>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.TableHead/#defaultprops","title":"defaultProps","text":"

\u25aa Static defaultProps: TableHeadProps

"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.TableHead/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#returns","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#overrides","title":"Overrides","text":"

React.Component.render

"},{"location":"extensions/api/classes/Renderer.Component.TableRow/","title":"Renderer.Component.TableRow","text":"

@k8slens/extensions / Exports / Renderer / Component / TableRow

"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#class-tablerowitem","title":"Class: TableRow<Item>","text":"

Renderer.Component.TableRow

"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#type-parameters","title":"Type parameters","text":"Name Item"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#hierarchy","title":"Hierarchy","text":"
  • Component<TableRowProps<Item>>

\u21b3 TableRow

"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.TableRow/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#methods","title":"Methods","text":"
  • render
"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.TableRow/#constructor","title":"constructor","text":"

\u2022 new TableRow<Item>(props)

"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#type-parameters_1","title":"Type parameters","text":"Name Item"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#parameters","title":"Parameters","text":"Name Type props TableRowProps<Item> | Readonly<TableRowProps<Item>>"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#inherited-from","title":"Inherited from","text":"

React.Component<TableRowProps<Item>>.constructor

\u2022 new TableRow<Item>(props, context)

Deprecated

See

https://legacy.reactjs.org/docs/legacy-context.html

"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#type-parameters_2","title":"Type parameters","text":"Name Item"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#parameters_1","title":"Parameters","text":"Name Type props TableRowProps<Item> context any"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#inherited-from_1","title":"Inherited from","text":"

React.Component<TableRowProps<Item>>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.TableRow/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#returns","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#overrides","title":"Overrides","text":"

React.Component.render

"},{"location":"extensions/api/classes/Renderer.Component.Tabs/","title":"Renderer.Component.Tabs","text":"

@k8slens/extensions / Exports / Renderer / Component / Tabs

"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#class-tabsd","title":"Class: Tabs<D>","text":"

Renderer.Component.Tabs

"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#type-parameters","title":"Type parameters","text":"Name D"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#hierarchy","title":"Hierarchy","text":"
  • PureComponent<TabsProps<D>>

\u21b3 Tabs

"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.Tabs/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#properties","title":"Properties","text":"
  • elem
"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#methods","title":"Methods","text":"
  • render
"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.Tabs/#constructor","title":"constructor","text":"

\u2022 new Tabs<D>(props)

"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#type-parameters_1","title":"Type parameters","text":"Name D"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#parameters","title":"Parameters","text":"Name Type props TabsProps<D> | Readonly<TabsProps<D>>"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#inherited-from","title":"Inherited from","text":"

React.PureComponent<TabsProps<D>>.constructor

\u2022 new Tabs<D>(props, context)

Deprecated

See

https://legacy.reactjs.org/docs/legacy-context.html

"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#type-parameters_2","title":"Type parameters","text":"Name D"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#parameters_1","title":"Parameters","text":"Name Type props TabsProps<D> context any"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#inherited-from_1","title":"Inherited from","text":"

React.PureComponent<TabsProps<D>>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.Tabs/#elem","title":"elem","text":"

\u2022 elem: null | HTMLDivElement

"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.Tabs/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#returns","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#overrides","title":"Overrides","text":"

React.PureComponent.render

"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/","title":"Renderer.Component.TerminalStore","text":"

@k8slens/extensions / Exports / Renderer / Component / TerminalStore

"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#class-terminalstore","title":"Class: TerminalStore","text":"

Renderer.Component.TerminalStore

"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#methods","title":"Methods","text":"
  • createInstance
  • getInstance
  • resetInstance
"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#constructor","title":"constructor","text":"

\u2022 new TerminalStore()

"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#createinstance","title":"createInstance","text":"

\u25b8 Static createInstance(): TerminalStore & { sendCommand: SendCommand }

"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#returns","title":"Returns","text":"

TerminalStore & { sendCommand: SendCommand }

"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#getinstance","title":"getInstance","text":"

\u25b8 Static getInstance(): TerminalStore & { sendCommand: SendCommand }

"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#returns_1","title":"Returns","text":"

TerminalStore & { sendCommand: SendCommand }

"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#resetinstance","title":"resetInstance","text":"

\u25b8 Static resetInstance(): void

"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/","title":"Renderer.Component.Wizard","text":"

@k8slens/extensions / Exports / Renderer / Component / Wizard

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#class-wizardd","title":"Class: Wizard<D>","text":"

Renderer.Component.Wizard

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#type-parameters","title":"Type parameters","text":"Name D"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#hierarchy","title":"Hierarchy","text":"
  • Component<WizardProps<D>, State>

\u21b3 Wizard

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.Wizard/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#properties","title":"Properties","text":"
  • firstStep
  • isFirstStep
  • isLastStep
  • lastStep
  • nextStep
  • prevStep
  • state
"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#accessors","title":"Accessors","text":"
  • step
  • steps
"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#methods","title":"Methods","text":"
  • getValidStep
  • render
"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.Wizard/#constructor","title":"constructor","text":"

\u2022 new Wizard<D>(props)

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#type-parameters_1","title":"Type parameters","text":"Name D"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#parameters","title":"Parameters","text":"Name Type props WizardProps<D> | Readonly<WizardProps<D>>"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#inherited-from","title":"Inherited from","text":"

React.Component<WizardProps<D>, State>.constructor

\u2022 new Wizard<D>(props, context)

Deprecated

See

https://legacy.reactjs.org/docs/legacy-context.html

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#type-parameters_2","title":"Type parameters","text":"Name D"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#parameters_1","title":"Parameters","text":"Name Type props WizardProps<D> context any"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#inherited-from_1","title":"Inherited from","text":"

React.Component<WizardProps<D>, State>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.Wizard/#firststep","title":"firstStep","text":"

\u2022 firstStep: () => any

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#type-declaration","title":"Type declaration","text":"

\u25b8 (): any

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#returns","title":"Returns","text":"

any

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#isfirststep","title":"isFirstStep","text":"

\u2022 isFirstStep: () => boolean

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (): boolean

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#returns_1","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#islaststep","title":"isLastStep","text":"

\u2022 isLastStep: () => boolean

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (): boolean

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#returns_2","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#laststep","title":"lastStep","text":"

\u2022 lastStep: () => any

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (): any

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#returns_3","title":"Returns","text":"

any

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#nextstep","title":"nextStep","text":"

\u2022 nextStep: () => any

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (): any

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#returns_4","title":"Returns","text":"

any

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#prevstep","title":"prevStep","text":"

\u2022 prevStep: () => any

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (): any

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#returns_5","title":"Returns","text":"

any

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#state","title":"state","text":"

\u2022 state: State

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#overrides","title":"Overrides","text":"

React.Component.state

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.Component.Wizard/#step","title":"step","text":"

\u2022 get step(): number

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#returns_6","title":"Returns","text":"

number

\u2022 set step(step): void

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#parameters_2","title":"Parameters","text":"Name Type step number"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#returns_7","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#steps","title":"steps","text":"

\u2022 get steps(): ReactElement<WizardStepProps<D>, string | JSXElementConstructor<any>>[]

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#returns_8","title":"Returns","text":"

ReactElement<WizardStepProps<D>, string | JSXElementConstructor<any>>[]

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.Wizard/#getvalidstep","title":"getValidStep","text":"

\u25b8 Protected getValidStep(step): number

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#parameters_3","title":"Parameters","text":"Name Type step number"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#returns_9","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#returns_10","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#overrides_1","title":"Overrides","text":"

React.Component.render

"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/","title":"Renderer.Component.WizardLayout","text":"

@k8slens/extensions / Exports / Renderer / Component / WizardLayout

"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#class-wizardlayout","title":"Class: WizardLayout","text":"

Renderer.Component.WizardLayout

"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#hierarchy","title":"Hierarchy","text":"
  • Component<WizardLayoutProps>

\u21b3 WizardLayout

"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#methods","title":"Methods","text":"
  • render
"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#constructor","title":"constructor","text":"

\u2022 new WizardLayout(props)

"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#parameters","title":"Parameters","text":"Name Type props WizardLayoutProps | Readonly<WizardLayoutProps>"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#inherited-from","title":"Inherited from","text":"

React.Component<WizardLayoutProps>.constructor

\u2022 new WizardLayout(props, context)

Deprecated

See

https://legacy.reactjs.org/docs/legacy-context.html

"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#parameters_1","title":"Parameters","text":"Name Type props WizardLayoutProps context any"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#inherited-from_1","title":"Inherited from","text":"

React.Component<WizardLayoutProps>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#returns","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#overrides","title":"Overrides","text":"

React.Component.render

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/","title":"Renderer.Component.WizardStep","text":"

@k8slens/extensions / Exports / Renderer / Component / WizardStep

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#class-wizardstepd","title":"Class: WizardStep<D>","text":"

Renderer.Component.WizardStep

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#type-parameters","title":"Type parameters","text":"Name D"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#hierarchy","title":"Hierarchy","text":"
  • Component<WizardStepProps<D>, WizardStepState>

\u21b3 WizardStep

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#properties","title":"Properties","text":"
  • next
  • prev
  • state
  • submit
  • defaultProps
"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#methods","title":"Methods","text":"
  • componentWillUnmount
  • keyDown
  • render
  • renderLoading
"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#constructor","title":"constructor","text":"

\u2022 new WizardStep<D>(props)

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#type-parameters_1","title":"Type parameters","text":"Name D"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#parameters","title":"Parameters","text":"Name Type props WizardStepProps<D> | Readonly<WizardStepProps<D>>"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#inherited-from","title":"Inherited from","text":"

React.Component<WizardStepProps<D>, WizardStepState>.constructor

\u2022 new WizardStep<D>(props, context)

Deprecated

See

https://legacy.reactjs.org/docs/legacy-context.html

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#type-parameters_2","title":"Type parameters","text":"Name D"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#parameters_1","title":"Parameters","text":"Name Type props WizardStepProps<D> context any"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#inherited-from_1","title":"Inherited from","text":"

React.Component<WizardStepProps<D>, WizardStepState>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#next","title":"next","text":"

\u2022 next: () => void

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#type-declaration","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#prev","title":"prev","text":"

\u2022 prev: () => void

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#state","title":"state","text":"

\u2022 state: WizardStepState

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#overrides","title":"Overrides","text":"

React.Component.state

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#submit","title":"submit","text":"

\u2022 submit: DebouncedFunc<() => void>

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#defaultprops","title":"defaultProps","text":"

\u25aa Static defaultProps: WizardStepProps<any>

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#componentwillunmount","title":"componentWillUnmount","text":"

\u25b8 componentWillUnmount(): void

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#overrides_1","title":"Overrides","text":"

React.Component.componentWillUnmount

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#keydown","title":"keyDown","text":"

\u25b8 keyDown(evt): void

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#parameters_2","title":"Parameters","text":"Name Type evt KeyboardEvent<HTMLElement>"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#render","title":"render","text":"

\u25b8 render(): null | Element

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#returns_4","title":"Returns","text":"

null | Element

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#overrides_2","title":"Overrides","text":"

React.Component.render

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#renderloading","title":"renderLoading","text":"

\u25b8 renderLoading(): Element

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#returns_5","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Ipc/","title":"Renderer.Ipc","text":"

@k8slens/extensions / Exports / Renderer / Ipc

"},{"location":"extensions/api/classes/Renderer.Ipc/#class-ipc","title":"Class: Ipc","text":"

Renderer.Ipc

"},{"location":"extensions/api/classes/Renderer.Ipc/#hierarchy","title":"Hierarchy","text":"
  • IpcRegistrar

\u21b3 Ipc

"},{"location":"extensions/api/classes/Renderer.Ipc/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Ipc/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Ipc/#properties","title":"Properties","text":"
  • [IpcPrefix]
  • extension
"},{"location":"extensions/api/classes/Renderer.Ipc/#methods","title":"Methods","text":"
  • broadcast
  • invoke
  • listen
  • createInstance
  • getInstance
  • resetInstance
"},{"location":"extensions/api/classes/Renderer.Ipc/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Ipc/#constructor","title":"constructor","text":"

\u2022 new Ipc(extension)

"},{"location":"extensions/api/classes/Renderer.Ipc/#parameters","title":"Parameters","text":"Name Type extension LensExtension"},{"location":"extensions/api/classes/Renderer.Ipc/#overrides","title":"Overrides","text":"

IpcRegistrar.constructor

"},{"location":"extensions/api/classes/Renderer.Ipc/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Ipc/#ipcprefix","title":"[IpcPrefix]","text":"

\u2022 Readonly [IpcPrefix]: string

"},{"location":"extensions/api/classes/Renderer.Ipc/#inherited-from","title":"Inherited from","text":"

IpcRegistrar.[IpcPrefix]

"},{"location":"extensions/api/classes/Renderer.Ipc/#extension","title":"extension","text":"

\u2022 Protected Readonly extension: LensExtension

"},{"location":"extensions/api/classes/Renderer.Ipc/#inherited-from_1","title":"Inherited from","text":"

IpcRegistrar.extension

"},{"location":"extensions/api/classes/Renderer.Ipc/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Ipc/#broadcast","title":"broadcast","text":"

\u25b8 broadcast(channel, ...args): void

"},{"location":"extensions/api/classes/Renderer.Ipc/#parameters_1","title":"Parameters","text":"Name Type Description channel string The channel to broadcast to your whole extension, both main and renderer ...args any[] The arguments passed to all listeners"},{"location":"extensions/api/classes/Renderer.Ipc/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Ipc/#inherited-from_2","title":"Inherited from","text":"

IpcRegistrar.broadcast

"},{"location":"extensions/api/classes/Renderer.Ipc/#invoke","title":"invoke","text":"

\u25b8 invoke(channel, ...args): Promise<any>

Request main to execute its function over the channel channel. This function only interacts with functions registered via Ipc.IpcMain.handleRpc An error will be thrown if no function has been registered on main with this channel ID.

"},{"location":"extensions/api/classes/Renderer.Ipc/#parameters_2","title":"Parameters","text":"Name Type Description channel string The channel to invoke a RPC on ...args any[] The arguments to pass to the RPC"},{"location":"extensions/api/classes/Renderer.Ipc/#returns_1","title":"Returns","text":"

Promise<any>

A promise of the resulting value

"},{"location":"extensions/api/classes/Renderer.Ipc/#listen","title":"listen","text":"

\u25b8 listen(channel, listener): Disposer

Listen for broadcasts within your extension. If the lifetime of the listener should be tied to the mounted lifetime of a component then putting the returned value in a disposeOnUnmount call will suffice.

"},{"location":"extensions/api/classes/Renderer.Ipc/#parameters_3","title":"Parameters","text":"Name Type Description channel string The channel to listen for broadcasts on listener (event: IpcRendererEvent, ...args: any[]) => any The function that will be called with the arguments of the broadcast"},{"location":"extensions/api/classes/Renderer.Ipc/#returns_2","title":"Returns","text":"

Disposer

An optional disposer, Lens will cleanup even if this is not called

"},{"location":"extensions/api/classes/Renderer.Ipc/#createinstance","title":"createInstance","text":"

\u25b8 Static createInstance<T, R>(this, ...args): T

Creates the single instance of the child class if one was not already created.

Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls.

Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used.

"},{"location":"extensions/api/classes/Renderer.Ipc/#type-parameters","title":"Type parameters","text":"Name Type T extends Singleton<T> R extends any[]"},{"location":"extensions/api/classes/Renderer.Ipc/#parameters_4","title":"Parameters","text":"Name Type Description this StaticThis<T, R> Implicit argument that is the child class type ...args R The constructor arguments for the child class"},{"location":"extensions/api/classes/Renderer.Ipc/#returns_3","title":"Returns","text":"

T

An instance of the child class

"},{"location":"extensions/api/classes/Renderer.Ipc/#inherited-from_3","title":"Inherited from","text":"

IpcRegistrar.createInstance

"},{"location":"extensions/api/classes/Renderer.Ipc/#getinstance","title":"getInstance","text":"

\u25b8 Static getInstance<T, R>(this, strict?): T

Get the instance of the child class that was previously created.

"},{"location":"extensions/api/classes/Renderer.Ipc/#type-parameters_1","title":"Type parameters","text":"Name Type T T R extends any[]"},{"location":"extensions/api/classes/Renderer.Ipc/#parameters_5","title":"Parameters","text":"Name Type Description this StaticThis<T, R> Implicit argument that is the child class type strict? true If false will return undefined instead of throwing when an instance doesn't exist. Default: true"},{"location":"extensions/api/classes/Renderer.Ipc/#returns_4","title":"Returns","text":"

T

An instance of the child class

"},{"location":"extensions/api/classes/Renderer.Ipc/#inherited-from_4","title":"Inherited from","text":"

IpcRegistrar.getInstance

\u25b8 Static getInstance<T, R>(this, strict): undefined | T

"},{"location":"extensions/api/classes/Renderer.Ipc/#type-parameters_2","title":"Type parameters","text":"Name Type T T R extends any[]"},{"location":"extensions/api/classes/Renderer.Ipc/#parameters_6","title":"Parameters","text":"Name Type this StaticThis<T, R> strict false"},{"location":"extensions/api/classes/Renderer.Ipc/#returns_5","title":"Returns","text":"

undefined | T

"},{"location":"extensions/api/classes/Renderer.Ipc/#inherited-from_5","title":"Inherited from","text":"

IpcRegistrar.getInstance

"},{"location":"extensions/api/classes/Renderer.Ipc/#resetinstance","title":"resetInstance","text":"

\u25b8 Static resetInstance(): void

Delete the instance of the child class.

Note: this doesn't prevent callers of getInstance from storing the result in a global.

There is no way in JS or TS to prevent globals like that.

"},{"location":"extensions/api/classes/Renderer.Ipc/#returns_6","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Ipc/#inherited-from_6","title":"Inherited from","text":"

IpcRegistrar.resetInstance

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/","title":"Renderer.K8sApi.CRDResourceStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / CRDResourceStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#class-crdresourcestorek","title":"Class: CRDResourceStore<K>","text":"

Renderer.K8sApi.CRDResourceStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#type-parameters","title":"Type parameters","text":"Name Type K extends KubeObject"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<K, KubeApi<K>>

\u21b3 CRDResourceStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#constructor","title":"constructor","text":"

\u2022 new CRDResourceStore<K>(deps, api)

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#type-parameters_1","title":"Type parameters","text":"Name Type K extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, K>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters","title":"Parameters","text":"Name Type deps KubeObjectStoreDependencies api KubeApi<K, KubeJsonApiDataFor<K>>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#overrides","title":"Overrides","text":"

KubeObjectStore<K, KubeApi<K\\>\\>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#api","title":"api","text":"

\u2022 Readonly api: KubeApi<K, KubeJsonApiDataFor<K>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: K) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_1","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiDataFor<K> extends KubeJsonApiDataFor<K> ? KubeJsonApiDataFor<K> : never>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#items","title":"items","text":"

\u2022 items: IObservableArray<K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<K, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_4","title":"Returns","text":"

Generator<K, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialDeep<K, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_6","title":"Returns","text":"

Promise<K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialDeep<K, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_7","title":"Returns","text":"

Promise<null | K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_5","title":"Parameters","text":"Name Type items K[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_8","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_9","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | K

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_10","title":"Returns","text":"

undefined | K

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_11","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | K

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_12","title":"Returns","text":"

undefined | K

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | K

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_13","title":"Returns","text":"

undefined | K

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_15","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_12","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? K[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#load","title":"load","text":"

\u25b8 load(params): Promise<K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_19","title":"Returns","text":"

Promise<K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | K[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_20","title":"Returns","text":"

Promise<undefined | K[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_21","title":"Returns","text":"

Promise<K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_22","title":"Returns","text":"

Promise<null | K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<K[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_23","title":"Returns","text":"

Promise<K[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_19","title":"Parameters","text":"Name Type partialItems K[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_24","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_20","title":"Parameters","text":"Name Type item K patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_25","title":"Returns","text":"

Promise<K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_21","title":"Parameters","text":"Name Type items K[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_26","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | K[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_27","title":"Returns","text":"

Promise<undefined | K[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_23","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_24","title":"Parameters","text":"Name Type item K request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_25","title":"Parameters","text":"Name Type items K[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_27","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): K[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_28","title":"Parameters","text":"Name Type Description items? K[] the items to be sorted (default: the current items in this store) sorting? (item: K) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_36","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_30","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? K[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_32","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_33","title":"Parameters","text":"Name Type item K data PartialDeep<K, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_41","title":"Returns","text":"

Promise<K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_34","title":"Parameters","text":"Name Type item K request () => Promise<K>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_43","title":"Returns","text":"

Promise<K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/","title":"Renderer.K8sApi.CRDStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / CRDStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#class-crdstore","title":"Class: CRDStore","text":"

Renderer.K8sApi.CRDStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<CustomResourceDefinition, CustomResourceDefinitionApi>

\u21b3 CRDStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#accessors","title":"Accessors","text":"
  • contextItems
  • groups
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getByGroup
  • getById
  • getByLabel
  • getByName
  • getByObject
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#constructor","title":"constructor","text":"

\u2022 new CRDStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api CustomResourceDefinitionApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#overrides","title":"Overrides","text":"

KubeObjectStore<CustomResourceDefinition, CustomResourceDefinitionApi\\>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#api","title":"api","text":"

\u2022 Readonly api: CustomResourceDefinitionApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: CustomResourceDefinition) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_1","title":"Parameters","text":"Name Type item CustomResourceDefinition"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<ClusterScopedMetadata, CustomResourceDefinitionStatus, CustomResourceDefinitionSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#items","title":"items","text":"

\u2022 items: IObservableArray<CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#groups","title":"groups","text":"

\u2022 get groups(): Record<string, CustomResourceDefinition[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_2","title":"Returns","text":"

Record<string, CustomResourceDefinition[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_3","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_4","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<CustomResourceDefinition, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_5","title":"Returns","text":"

Generator<CustomResourceDefinition, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_6","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<CustomResourceDefinition, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_7","title":"Returns","text":"

Promise<CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<CustomResourceDefinition, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_8","title":"Returns","text":"

Promise<null | CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): CustomResourceDefinition[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_5","title":"Parameters","text":"Name Type items CustomResourceDefinition[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_9","title":"Returns","text":"

CustomResourceDefinition[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): CustomResourceDefinition[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_10","title":"Returns","text":"

CustomResourceDefinition[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbygroup","title":"getByGroup","text":"

\u25b8 getByGroup(group, pluralName): undefined | CustomResourceDefinition

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_7","title":"Parameters","text":"Name Type group string pluralName string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_11","title":"Returns","text":"

undefined | CustomResourceDefinition

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | CustomResourceDefinition

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_8","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_12","title":"Returns","text":"

undefined | CustomResourceDefinition

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): CustomResourceDefinition[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_9","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_13","title":"Returns","text":"

CustomResourceDefinition[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | CustomResourceDefinition

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_10","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_14","title":"Returns","text":"

undefined | CustomResourceDefinition

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbyobject","title":"getByObject","text":"

\u25b8 getByObject(obj): undefined | CustomResourceDefinition

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_11","title":"Parameters","text":"Name Type obj KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_15","title":"Returns","text":"

undefined | CustomResourceDefinition

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | CustomResourceDefinition

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_12","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_16","title":"Returns","text":"

undefined | CustomResourceDefinition

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_13","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_17","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): CustomResourceDefinition[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_18","title":"Returns","text":"

CustomResourceDefinition[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_19","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_14","title":"Parameters","text":"Name Type item CustomResourceDefinition"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_20","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_15","title":"Parameters","text":"Name Type visibleItems? CustomResourceDefinition[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_21","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#load","title":"load","text":"

\u25b8 load(params): Promise<CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_16","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_22","title":"Returns","text":"

Promise<CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | CustomResourceDefinition[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_17","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_23","title":"Returns","text":"

Promise<undefined | CustomResourceDefinition[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_18","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_24","title":"Returns","text":"

Promise<CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_19","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_25","title":"Returns","text":"

Promise<null | CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<CustomResourceDefinition[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_20","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_26","title":"Returns","text":"

Promise<CustomResourceDefinition[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): CustomResourceDefinition[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_21","title":"Parameters","text":"Name Type partialItems CustomResourceDefinition[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_27","title":"Returns","text":"

CustomResourceDefinition[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_22","title":"Parameters","text":"Name Type item CustomResourceDefinition patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_28","title":"Returns","text":"

Promise<CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): CustomResourceDefinition[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_23","title":"Parameters","text":"Name Type items CustomResourceDefinition[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_29","title":"Returns","text":"

CustomResourceDefinition[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | CustomResourceDefinition[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_24","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_30","title":"Returns","text":"

Promise<undefined | CustomResourceDefinition[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_25","title":"Parameters","text":"Name Type item CustomResourceDefinition"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_26","title":"Parameters","text":"Name Type item CustomResourceDefinition request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_32","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_27","title":"Parameters","text":"Name Type items CustomResourceDefinition[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_33","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_34","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_28","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_36","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_37","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_29","title":"Parameters","text":"Name Type item CustomResourceDefinition"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items): CustomResourceDefinition[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_30","title":"Parameters","text":"Name Type items CustomResourceDefinition[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_39","title":"Returns","text":"

CustomResourceDefinition[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#overrides_1","title":"Overrides","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_31","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_40","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_32","title":"Parameters","text":"Name Type item CustomResourceDefinition"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_41","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_33","title":"Parameters","text":"Name Type visibleItems? CustomResourceDefinition[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_34","title":"Parameters","text":"Name Type item CustomResourceDefinition"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_43","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_35","title":"Parameters","text":"Name Type item CustomResourceDefinition data PartialObjectDeep<CustomResourceDefinition, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_44","title":"Returns","text":"

Promise<CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_45","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_36","title":"Parameters","text":"Name Type item CustomResourceDefinition request () => Promise<CustomResourceDefinition>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_46","title":"Returns","text":"

Promise<CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/","title":"Renderer.K8sApi.ConfigMapsStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / ConfigMapsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#class-configmapsstore","title":"Class: ConfigMapsStore","text":"

Renderer.K8sApi.ConfigMapsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<ConfigMap, ConfigMapApi, ConfigMapData>

\u21b3 ConfigMapsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#constructor","title":"constructor","text":"

\u2022 new ConfigMapsStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api ConfigMapApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<ConfigMap, ConfigMapApi, ConfigMapData>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#api","title":"api","text":"

\u2022 Readonly api: ConfigMapApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: ConfigMap) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_1","title":"Parameters","text":"Name Type item ConfigMap"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<ConfigMapData>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#items","title":"items","text":"

\u2022 items: IObservableArray<ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<ConfigMap, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_4","title":"Returns","text":"

Generator<ConfigMap, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<ConfigMap, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_6","title":"Returns","text":"

Promise<ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<ConfigMap, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_7","title":"Returns","text":"

Promise<null | ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): ConfigMap[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_5","title":"Parameters","text":"Name Type items ConfigMap[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_8","title":"Returns","text":"

ConfigMap[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): ConfigMap[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_9","title":"Returns","text":"

ConfigMap[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | ConfigMap

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_10","title":"Returns","text":"

undefined | ConfigMap

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): ConfigMap[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_11","title":"Returns","text":"

ConfigMap[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | ConfigMap

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_12","title":"Returns","text":"

undefined | ConfigMap

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | ConfigMap

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_13","title":"Returns","text":"

undefined | ConfigMap

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): ConfigMap[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_15","title":"Returns","text":"

ConfigMap[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_12","title":"Parameters","text":"Name Type item ConfigMap"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? ConfigMap[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#load","title":"load","text":"

\u25b8 load(params): Promise<ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_19","title":"Returns","text":"

Promise<ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | ConfigMap[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_20","title":"Returns","text":"

Promise<undefined | ConfigMap[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_21","title":"Returns","text":"

Promise<ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_22","title":"Returns","text":"

Promise<null | ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<ConfigMap[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_23","title":"Returns","text":"

Promise<ConfigMap[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): ConfigMap[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_19","title":"Parameters","text":"Name Type partialItems ConfigMap[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_24","title":"Returns","text":"

ConfigMap[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_20","title":"Parameters","text":"Name Type item ConfigMap patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_25","title":"Returns","text":"

Promise<ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): ConfigMap[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_21","title":"Parameters","text":"Name Type items ConfigMap[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_26","title":"Returns","text":"

ConfigMap[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | ConfigMap[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_27","title":"Returns","text":"

Promise<undefined | ConfigMap[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_23","title":"Parameters","text":"Name Type item ConfigMap"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_24","title":"Parameters","text":"Name Type item ConfigMap request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_25","title":"Parameters","text":"Name Type items ConfigMap[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_27","title":"Parameters","text":"Name Type item ConfigMap"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): ConfigMap[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_28","title":"Parameters","text":"Name Type Description items? ConfigMap[] the items to be sorted (default: the current items in this store) sorting? (item: ConfigMap) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_36","title":"Returns","text":"

ConfigMap[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_30","title":"Parameters","text":"Name Type item ConfigMap"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? ConfigMap[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_32","title":"Parameters","text":"Name Type item ConfigMap"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_33","title":"Parameters","text":"Name Type item ConfigMap data PartialObjectDeep<ConfigMap, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_41","title":"Returns","text":"

Promise<ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_34","title":"Parameters","text":"Name Type item ConfigMap request () => Promise<ConfigMap>"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_43","title":"Returns","text":"

Promise<ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/","title":"Renderer.K8sApi.CronJobStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / CronJobStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#class-cronjobstore","title":"Class: CronJobStore","text":"

Renderer.K8sApi.CronJobStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<CronJob, CronJobApi>

\u21b3 CronJobStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getActiveJobsNum
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getStatuses
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#constructor","title":"constructor","text":"

\u2022 new CronJobStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters","title":"Parameters","text":"Name Type dependencies Dependencies api CronJobApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#overrides","title":"Overrides","text":"

KubeObjectStore<CronJob, CronJobApi\\>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#api","title":"api","text":"

\u2022 Readonly api: CronJobApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: CronJob) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_1","title":"Parameters","text":"Name Type item CronJob"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: Dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#overrides_1","title":"Overrides","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, CronJobStatus, CronJobSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#items","title":"items","text":"

\u2022 items: IObservableArray<CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<CronJob, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_4","title":"Returns","text":"

Generator<CronJob, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<CronJob, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_6","title":"Returns","text":"

Promise<CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<CronJob, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_7","title":"Returns","text":"

Promise<null | CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): CronJob[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_5","title":"Parameters","text":"Name Type items CronJob[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_8","title":"Returns","text":"

CronJob[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getactivejobsnum","title":"getActiveJobsNum","text":"

\u25b8 getActiveJobsNum(cronJob): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_6","title":"Parameters","text":"Name Type cronJob CronJob"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_9","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): CronJob[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_7","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_10","title":"Returns","text":"

CronJob[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | CronJob

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_8","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_11","title":"Returns","text":"

undefined | CronJob

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): CronJob[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_9","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_12","title":"Returns","text":"

CronJob[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | CronJob

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_10","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_13","title":"Returns","text":"

undefined | CronJob

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | CronJob

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_11","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_14","title":"Returns","text":"

undefined | CronJob

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_12","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): CronJob[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_16","title":"Returns","text":"

CronJob[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getstatuses","title":"getStatuses","text":"

\u25b8 getStatuses(cronJobs?): Object

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_13","title":"Parameters","text":"Name Type cronJobs? CronJob[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_17","title":"Returns","text":"

Object

Name Type scheduled number suspended number"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_18","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_14","title":"Parameters","text":"Name Type item CronJob"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_19","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_15","title":"Parameters","text":"Name Type visibleItems? CronJob[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_20","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#load","title":"load","text":"

\u25b8 load(params): Promise<CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_16","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_21","title":"Returns","text":"

Promise<CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | CronJob[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_17","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_22","title":"Returns","text":"

Promise<undefined | CronJob[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_18","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_23","title":"Returns","text":"

Promise<CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_19","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_24","title":"Returns","text":"

Promise<null | CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<CronJob[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_20","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_25","title":"Returns","text":"

Promise<CronJob[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): CronJob[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_21","title":"Parameters","text":"Name Type partialItems CronJob[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_26","title":"Returns","text":"

CronJob[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_22","title":"Parameters","text":"Name Type item CronJob patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_27","title":"Returns","text":"

Promise<CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): CronJob[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_23","title":"Parameters","text":"Name Type items CronJob[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_28","title":"Returns","text":"

CronJob[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | CronJob[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_24","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_29","title":"Returns","text":"

Promise<undefined | CronJob[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_25","title":"Parameters","text":"Name Type item CronJob"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_26","title":"Parameters","text":"Name Type item CronJob request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_27","title":"Parameters","text":"Name Type items CronJob[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_32","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_33","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_28","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_36","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_29","title":"Parameters","text":"Name Type item CronJob"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_37","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): CronJob[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_30","title":"Parameters","text":"Name Type Description items? CronJob[] the items to be sorted (default: the current items in this store) sorting? (item: CronJob) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_38","title":"Returns","text":"

CronJob[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_31","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_39","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_32","title":"Parameters","text":"Name Type item CronJob"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_33","title":"Parameters","text":"Name Type visibleItems? CronJob[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_41","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_34","title":"Parameters","text":"Name Type item CronJob"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_35","title":"Parameters","text":"Name Type item CronJob data PartialObjectDeep<CronJob, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_43","title":"Returns","text":"

Promise<CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_44","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_36","title":"Parameters","text":"Name Type item CronJob request () => Promise<CronJob>"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_45","title":"Returns","text":"

Promise<CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/","title":"Renderer.K8sApi.DaemonSetStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / DaemonSetStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#class-daemonsetstore","title":"Class: DaemonSetStore","text":"

Renderer.K8sApi.DaemonSetStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<DaemonSet, DaemonSetApi>

\u21b3 DaemonSetStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getChildPods
  • getIndexById
  • getItems
  • getStatuses
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#constructor","title":"constructor","text":"

\u2022 new DaemonSetStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters","title":"Parameters","text":"Name Type dependencies DaemonSetStoreDependencies api DaemonSetApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#overrides","title":"Overrides","text":"

KubeObjectStore<DaemonSet, DaemonSetApi\\>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#api","title":"api","text":"

\u2022 Readonly api: DaemonSetApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: DaemonSet) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_1","title":"Parameters","text":"Name Type item DaemonSet"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: DaemonSetStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#overrides_1","title":"Overrides","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, DaemonSetStatus, DaemonSetSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#items","title":"items","text":"

\u2022 items: IObservableArray<DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<DaemonSet, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_4","title":"Returns","text":"

Generator<DaemonSet, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<DaemonSet, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_6","title":"Returns","text":"

Promise<DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<DaemonSet, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_7","title":"Returns","text":"

Promise<null | DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): DaemonSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_5","title":"Parameters","text":"Name Type items DaemonSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_8","title":"Returns","text":"

DaemonSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): DaemonSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_9","title":"Returns","text":"

DaemonSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | DaemonSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_10","title":"Returns","text":"

undefined | DaemonSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): DaemonSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_11","title":"Returns","text":"

DaemonSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | DaemonSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_12","title":"Returns","text":"

undefined | DaemonSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | DaemonSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_13","title":"Returns","text":"

undefined | DaemonSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getchildpods","title":"getChildPods","text":"

\u25b8 getChildPods(daemonSet): Pod[]

Deprecated

Switch to using getPodsByOwnerId directly

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_11","title":"Parameters","text":"Name Type daemonSet DaemonSet"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_14","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_12","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): DaemonSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_16","title":"Returns","text":"

DaemonSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getstatuses","title":"getStatuses","text":"

\u25b8 getStatuses(daemonSets?): Object

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_13","title":"Parameters","text":"Name Type daemonSets? DaemonSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_17","title":"Returns","text":"

Object

Name Type failed number pending number running number"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_18","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_14","title":"Parameters","text":"Name Type item DaemonSet"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_19","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_15","title":"Parameters","text":"Name Type visibleItems? DaemonSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_20","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#load","title":"load","text":"

\u25b8 load(params): Promise<DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_16","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_21","title":"Returns","text":"

Promise<DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | DaemonSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_17","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_22","title":"Returns","text":"

Promise<undefined | DaemonSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_18","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_23","title":"Returns","text":"

Promise<DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_19","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_24","title":"Returns","text":"

Promise<null | DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<DaemonSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_20","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_25","title":"Returns","text":"

Promise<DaemonSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): DaemonSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_21","title":"Parameters","text":"Name Type partialItems DaemonSet[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_26","title":"Returns","text":"

DaemonSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_22","title":"Parameters","text":"Name Type item DaemonSet patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_27","title":"Returns","text":"

Promise<DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): DaemonSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_23","title":"Parameters","text":"Name Type items DaemonSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_28","title":"Returns","text":"

DaemonSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | DaemonSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_24","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_29","title":"Returns","text":"

Promise<undefined | DaemonSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_25","title":"Parameters","text":"Name Type item DaemonSet"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_26","title":"Parameters","text":"Name Type item DaemonSet request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_27","title":"Parameters","text":"Name Type items DaemonSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_32","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_33","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_28","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_36","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_29","title":"Parameters","text":"Name Type item DaemonSet"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_37","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): DaemonSet[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_30","title":"Parameters","text":"Name Type Description items? DaemonSet[] the items to be sorted (default: the current items in this store) sorting? (item: DaemonSet) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_38","title":"Returns","text":"

DaemonSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_31","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_39","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_32","title":"Parameters","text":"Name Type item DaemonSet"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_33","title":"Parameters","text":"Name Type visibleItems? DaemonSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_41","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_34","title":"Parameters","text":"Name Type item DaemonSet"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_35","title":"Parameters","text":"Name Type item DaemonSet data PartialObjectDeep<DaemonSet, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_43","title":"Returns","text":"

Promise<DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_44","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_36","title":"Parameters","text":"Name Type item DaemonSet request () => Promise<DaemonSet>"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_45","title":"Returns","text":"

Promise<DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/","title":"Renderer.K8sApi.DeploymentStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / DeploymentStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#class-deploymentstore","title":"Class: DeploymentStore","text":"

Renderer.K8sApi.DeploymentStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<Deployment, DeploymentApi>

\u21b3 DeploymentStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getChildPods
  • getIndexById
  • getItems
  • getStatuses
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#constructor","title":"constructor","text":"

\u2022 new DeploymentStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters","title":"Parameters","text":"Name Type dependencies DeploymentStoreDependencies api DeploymentApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#overrides","title":"Overrides","text":"

KubeObjectStore<Deployment, DeploymentApi\\>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#api","title":"api","text":"

\u2022 Readonly api: DeploymentApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: Deployment) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_1","title":"Parameters","text":"Name Type item Deployment"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: DeploymentStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#overrides_1","title":"Overrides","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, DeploymentStatus, DeploymentSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#items","title":"items","text":"

\u2022 items: IObservableArray<Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<Deployment, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_4","title":"Returns","text":"

Generator<Deployment, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Deployment, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_6","title":"Returns","text":"

Promise<Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Deployment, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_7","title":"Returns","text":"

Promise<null | Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): Deployment[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_5","title":"Parameters","text":"Name Type items Deployment[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_8","title":"Returns","text":"

Deployment[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): Deployment[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_9","title":"Returns","text":"

Deployment[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | Deployment

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_10","title":"Returns","text":"

undefined | Deployment

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): Deployment[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_11","title":"Returns","text":"

Deployment[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | Deployment

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_12","title":"Returns","text":"

undefined | Deployment

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | Deployment

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_13","title":"Returns","text":"

undefined | Deployment

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getchildpods","title":"getChildPods","text":"

\u25b8 getChildPods(deployment): Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_11","title":"Parameters","text":"Name Type deployment Deployment"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_14","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_12","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): Deployment[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_16","title":"Returns","text":"

Deployment[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getstatuses","title":"getStatuses","text":"

\u25b8 getStatuses(deployments): DeploymentStatuses

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_13","title":"Parameters","text":"Name Type deployments Deployment[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_17","title":"Returns","text":"

DeploymentStatuses

\u25b8 getStatuses(deployments): DeploymentStatuses

Deprecated

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_14","title":"Parameters","text":"Name Type deployments undefined | Deployment[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_18","title":"Returns","text":"

DeploymentStatuses

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_19","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_15","title":"Parameters","text":"Name Type item Deployment"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_20","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_16","title":"Parameters","text":"Name Type visibleItems? Deployment[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_21","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#load","title":"load","text":"

\u25b8 load(params): Promise<Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_22","title":"Returns","text":"

Promise<Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Deployment[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_23","title":"Returns","text":"

Promise<undefined | Deployment[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_19","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_24","title":"Returns","text":"

Promise<Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_20","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_25","title":"Returns","text":"

Promise<null | Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<Deployment[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_21","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_26","title":"Returns","text":"

Promise<Deployment[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Deployment[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_22","title":"Parameters","text":"Name Type partialItems Deployment[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_27","title":"Returns","text":"

Deployment[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_23","title":"Parameters","text":"Name Type item Deployment patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_28","title":"Returns","text":"

Promise<Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): Deployment[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_24","title":"Parameters","text":"Name Type items Deployment[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_29","title":"Returns","text":"

Deployment[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | Deployment[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_25","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_30","title":"Returns","text":"

Promise<undefined | Deployment[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_26","title":"Parameters","text":"Name Type item Deployment"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_27","title":"Parameters","text":"Name Type item Deployment request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_32","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_28","title":"Parameters","text":"Name Type items Deployment[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_33","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_34","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_29","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_36","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_37","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_30","title":"Parameters","text":"Name Type item Deployment"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items): Deployment[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_31","title":"Parameters","text":"Name Type items Deployment[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_39","title":"Returns","text":"

Deployment[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#overrides_2","title":"Overrides","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_32","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_40","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_33","title":"Parameters","text":"Name Type item Deployment"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_41","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_34","title":"Parameters","text":"Name Type visibleItems? Deployment[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_35","title":"Parameters","text":"Name Type item Deployment"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_43","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_36","title":"Parameters","text":"Name Type item Deployment data PartialObjectDeep<Deployment, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_44","title":"Returns","text":"

Promise<Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_45","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_37","title":"Parameters","text":"Name Type item Deployment request () => Promise<Deployment>"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_46","title":"Returns","text":"

Promise<Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/","title":"Renderer.K8sApi.EndpointStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / EndpointStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#class-endpointstore","title":"Class: EndpointStore","text":"

Renderer.K8sApi.EndpointStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<Endpoint, EndpointsApi, EndpointsData>

\u21b3 EndpointStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#constructor","title":"constructor","text":"

\u2022 new EndpointStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api EndpointsApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<Endpoints, EndpointsApi, EndpointsData>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#api","title":"api","text":"

\u2022 Readonly api: EndpointsApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: Endpoint) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_1","title":"Parameters","text":"Name Type item Endpoint"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<EndpointsData>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#items","title":"items","text":"

\u2022 items: IObservableArray<Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<Endpoint, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_4","title":"Returns","text":"

Generator<Endpoint, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Endpoint, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_6","title":"Returns","text":"

Promise<Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Endpoint, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_7","title":"Returns","text":"

Promise<null | Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): Endpoint[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_5","title":"Parameters","text":"Name Type items Endpoint[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_8","title":"Returns","text":"

Endpoint[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): Endpoint[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_9","title":"Returns","text":"

Endpoint[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | Endpoint

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_10","title":"Returns","text":"

undefined | Endpoint

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): Endpoint[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_11","title":"Returns","text":"

Endpoint[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | Endpoint

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_12","title":"Returns","text":"

undefined | Endpoint

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | Endpoint

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_13","title":"Returns","text":"

undefined | Endpoint

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): Endpoint[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_15","title":"Returns","text":"

Endpoint[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_12","title":"Parameters","text":"Name Type item Endpoint"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? Endpoint[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#load","title":"load","text":"

\u25b8 load(params): Promise<Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_19","title":"Returns","text":"

Promise<Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Endpoint[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_20","title":"Returns","text":"

Promise<undefined | Endpoint[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_21","title":"Returns","text":"

Promise<Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_22","title":"Returns","text":"

Promise<null | Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<Endpoint[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_23","title":"Returns","text":"

Promise<Endpoint[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Endpoint[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_19","title":"Parameters","text":"Name Type partialItems Endpoint[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_24","title":"Returns","text":"

Endpoint[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_20","title":"Parameters","text":"Name Type item Endpoint patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_25","title":"Returns","text":"

Promise<Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): Endpoint[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_21","title":"Parameters","text":"Name Type items Endpoint[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_26","title":"Returns","text":"

Endpoint[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | Endpoint[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_27","title":"Returns","text":"

Promise<undefined | Endpoint[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_23","title":"Parameters","text":"Name Type item Endpoint"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_24","title":"Parameters","text":"Name Type item Endpoint request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_25","title":"Parameters","text":"Name Type items Endpoint[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_27","title":"Parameters","text":"Name Type item Endpoint"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): Endpoint[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_28","title":"Parameters","text":"Name Type Description items? Endpoint[] the items to be sorted (default: the current items in this store) sorting? (item: Endpoint) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_36","title":"Returns","text":"

Endpoint[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_30","title":"Parameters","text":"Name Type item Endpoint"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? Endpoint[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_32","title":"Parameters","text":"Name Type item Endpoint"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_33","title":"Parameters","text":"Name Type item Endpoint data PartialObjectDeep<Endpoint, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_41","title":"Returns","text":"

Promise<Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_34","title":"Parameters","text":"Name Type item Endpoint request () => Promise<Endpoint>"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_43","title":"Returns","text":"

Promise<Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/","title":"Renderer.K8sApi.EventStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / EventStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#class-eventstore","title":"Class: EventStore","text":"

Renderer.K8sApi.EventStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<KubeEvent, KubeEventApi>

\u21b3 EventStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getEventsByObject
  • getIndexById
  • getItems
  • getTotalCount
  • getWarnings
  • getWarningsCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#constructor","title":"constructor","text":"

\u2022 new EventStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters","title":"Parameters","text":"Name Type dependencies EventStoreDependencies api KubeEventApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#overrides","title":"Overrides","text":"

KubeObjectStore<KubeEvent, KubeEventApi\\>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#api","title":"api","text":"

\u2022 Readonly api: KubeEventApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: KubeEvent) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_1","title":"Parameters","text":"Name Type item KubeEvent"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: EventStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#overrides_1","title":"Overrides","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeEventData>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#items","title":"items","text":"

\u2022 items: IObservableArray<KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#limit","title":"limit","text":"

\u2022 Readonly limit: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#overrides_2","title":"Overrides","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<KubeEvent, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_4","title":"Returns","text":"

Generator<KubeEvent, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#overrides_3","title":"Overrides","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_2","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<KubeEvent, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_6","title":"Returns","text":"

Promise<KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<KubeEvent, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_7","title":"Returns","text":"

Promise<null | KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_4","title":"Parameters","text":"Name Type items KubeEvent[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_8","title":"Returns","text":"

KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_5","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_9","title":"Returns","text":"

KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | KubeEvent

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_6","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_10","title":"Returns","text":"

undefined | KubeEvent

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_7","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_11","title":"Returns","text":"

KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | KubeEvent

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_8","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_12","title":"Returns","text":"

undefined | KubeEvent

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | KubeEvent

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_9","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_13","title":"Returns","text":"

undefined | KubeEvent

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#geteventsbyobject","title":"getEventsByObject","text":"

\u25b8 getEventsByObject(obj): KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_10","title":"Parameters","text":"Name Type obj KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_14","title":"Returns","text":"

KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_16","title":"Returns","text":"

KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_17","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getwarnings","title":"getWarnings","text":"

\u25b8 getWarnings(): KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_18","title":"Returns","text":"

KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getwarningscount","title":"getWarningsCount","text":"

\u25b8 getWarningsCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_19","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_12","title":"Parameters","text":"Name Type item KubeEvent"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_20","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? KubeEvent[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_21","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#load","title":"load","text":"

\u25b8 load(params): Promise<KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_22","title":"Returns","text":"

Promise<KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | KubeEvent[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_23","title":"Returns","text":"

Promise<undefined | KubeEvent[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_24","title":"Returns","text":"

Promise<KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_25","title":"Returns","text":"

Promise<null | KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<KubeEvent[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_26","title":"Returns","text":"

Promise<KubeEvent[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_19","title":"Parameters","text":"Name Type partialItems KubeEvent[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_27","title":"Returns","text":"

KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_20","title":"Parameters","text":"Name Type item KubeEvent patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_28","title":"Returns","text":"

Promise<KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_21","title":"Parameters","text":"Name Type items KubeEvent[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_29","title":"Returns","text":"

KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | KubeEvent[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_30","title":"Returns","text":"

Promise<undefined | KubeEvent[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_23","title":"Parameters","text":"Name Type item KubeEvent"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_24","title":"Parameters","text":"Name Type item KubeEvent request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_32","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_25","title":"Parameters","text":"Name Type items KubeEvent[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_33","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_34","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_36","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_37","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_27","title":"Parameters","text":"Name Type item KubeEvent"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items): KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_28","title":"Parameters","text":"Name Type items KubeEvent[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_39","title":"Returns","text":"

KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#overrides_4","title":"Overrides","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_40","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_30","title":"Parameters","text":"Name Type item KubeEvent"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_41","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? KubeEvent[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_32","title":"Parameters","text":"Name Type item KubeEvent"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_43","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_33","title":"Parameters","text":"Name Type item KubeEvent data PartialObjectDeep<KubeEvent, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_44","title":"Returns","text":"

Promise<KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_45","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_34","title":"Parameters","text":"Name Type item KubeEvent request () => Promise<KubeEvent>"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_46","title":"Returns","text":"

Promise<KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/","title":"Renderer.K8sApi.HPAStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / HPAStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#class-hpastore","title":"Class: HPAStore","text":"

Renderer.K8sApi.HPAStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<HorizontalPodAutoscaler, HorizontalPodAutoscalerApi>

\u21b3 HPAStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#constructor","title":"constructor","text":"

\u2022 new HPAStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api HorizontalPodAutoscalerApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<HorizontalPodAutoscaler, HorizontalPodAutoscalerApi>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#api","title":"api","text":"

\u2022 Readonly api: HorizontalPodAutoscalerApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: HorizontalPodAutoscaler) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_1","title":"Parameters","text":"Name Type item HorizontalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, HorizontalPodAutoscalerStatus, HorizontalPodAutoscalerSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#items","title":"items","text":"

\u2022 items: IObservableArray<HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<HorizontalPodAutoscaler, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_4","title":"Returns","text":"

Generator<HorizontalPodAutoscaler, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<HorizontalPodAutoscaler, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_6","title":"Returns","text":"

Promise<HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<HorizontalPodAutoscaler, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_7","title":"Returns","text":"

Promise<null | HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): HorizontalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_5","title":"Parameters","text":"Name Type items HorizontalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_8","title":"Returns","text":"

HorizontalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): HorizontalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_9","title":"Returns","text":"

HorizontalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | HorizontalPodAutoscaler

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_10","title":"Returns","text":"

undefined | HorizontalPodAutoscaler

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): HorizontalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_11","title":"Returns","text":"

HorizontalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | HorizontalPodAutoscaler

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_12","title":"Returns","text":"

undefined | HorizontalPodAutoscaler

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | HorizontalPodAutoscaler

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_13","title":"Returns","text":"

undefined | HorizontalPodAutoscaler

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): HorizontalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_15","title":"Returns","text":"

HorizontalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_12","title":"Parameters","text":"Name Type item HorizontalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? HorizontalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#load","title":"load","text":"

\u25b8 load(params): Promise<HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_19","title":"Returns","text":"

Promise<HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | HorizontalPodAutoscaler[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_20","title":"Returns","text":"

Promise<undefined | HorizontalPodAutoscaler[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_21","title":"Returns","text":"

Promise<HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_22","title":"Returns","text":"

Promise<null | HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<HorizontalPodAutoscaler[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_23","title":"Returns","text":"

Promise<HorizontalPodAutoscaler[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): HorizontalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_19","title":"Parameters","text":"Name Type partialItems HorizontalPodAutoscaler[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_24","title":"Returns","text":"

HorizontalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_20","title":"Parameters","text":"Name Type item HorizontalPodAutoscaler patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_25","title":"Returns","text":"

Promise<HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): HorizontalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_21","title":"Parameters","text":"Name Type items HorizontalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_26","title":"Returns","text":"

HorizontalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | HorizontalPodAutoscaler[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_27","title":"Returns","text":"

Promise<undefined | HorizontalPodAutoscaler[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_23","title":"Parameters","text":"Name Type item HorizontalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_24","title":"Parameters","text":"Name Type item HorizontalPodAutoscaler request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_25","title":"Parameters","text":"Name Type items HorizontalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_27","title":"Parameters","text":"Name Type item HorizontalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): HorizontalPodAutoscaler[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_28","title":"Parameters","text":"Name Type Description items? HorizontalPodAutoscaler[] the items to be sorted (default: the current items in this store) sorting? (item: HorizontalPodAutoscaler) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_36","title":"Returns","text":"

HorizontalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_30","title":"Parameters","text":"Name Type item HorizontalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? HorizontalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_32","title":"Parameters","text":"Name Type item HorizontalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_33","title":"Parameters","text":"Name Type item HorizontalPodAutoscaler data PartialObjectDeep<HorizontalPodAutoscaler, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_41","title":"Returns","text":"

Promise<HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_34","title":"Parameters","text":"Name Type item HorizontalPodAutoscaler request () => Promise<HorizontalPodAutoscaler>"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_43","title":"Returns","text":"

Promise<HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/","title":"Renderer.K8sApi.IngressClassStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / IngressClassStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#class-ingressclassstore","title":"Class: IngressClassStore","text":"

Renderer.K8sApi.IngressClassStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<IngressClass, IngressClassApi>

\u21b3 IngressClassStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#constructor","title":"constructor","text":"

\u2022 new IngressClassStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api IngressClassApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<IngressClass, IngressClassApi>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#api","title":"api","text":"

\u2022 Readonly api: IngressClassApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: IngressClass) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_1","title":"Parameters","text":"Name Type item IngressClass"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<ClusterScopedMetadata, IngressClassStatus, IngressClassSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#items","title":"items","text":"

\u2022 items: IObservableArray<IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<IngressClass, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_4","title":"Returns","text":"

Generator<IngressClass, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<IngressClass, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_6","title":"Returns","text":"

Promise<IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<IngressClass, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_7","title":"Returns","text":"

Promise<null | IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): IngressClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_5","title":"Parameters","text":"Name Type items IngressClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_8","title":"Returns","text":"

IngressClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): IngressClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_9","title":"Returns","text":"

IngressClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | IngressClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_10","title":"Returns","text":"

undefined | IngressClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): IngressClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_11","title":"Returns","text":"

IngressClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | IngressClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_12","title":"Returns","text":"

undefined | IngressClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | IngressClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_13","title":"Returns","text":"

undefined | IngressClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): IngressClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_15","title":"Returns","text":"

IngressClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_12","title":"Parameters","text":"Name Type item IngressClass"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? IngressClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#load","title":"load","text":"

\u25b8 load(params): Promise<IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_19","title":"Returns","text":"

Promise<IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | IngressClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_20","title":"Returns","text":"

Promise<undefined | IngressClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_21","title":"Returns","text":"

Promise<IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_22","title":"Returns","text":"

Promise<null | IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<IngressClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_23","title":"Returns","text":"

Promise<IngressClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): IngressClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_19","title":"Parameters","text":"Name Type partialItems IngressClass[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_24","title":"Returns","text":"

IngressClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_20","title":"Parameters","text":"Name Type item IngressClass patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_25","title":"Returns","text":"

Promise<IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): IngressClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_21","title":"Parameters","text":"Name Type items IngressClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_26","title":"Returns","text":"

IngressClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | IngressClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_27","title":"Returns","text":"

Promise<undefined | IngressClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_23","title":"Parameters","text":"Name Type item IngressClass"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_24","title":"Parameters","text":"Name Type item IngressClass request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_25","title":"Parameters","text":"Name Type items IngressClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_27","title":"Parameters","text":"Name Type item IngressClass"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): IngressClass[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_28","title":"Parameters","text":"Name Type Description items? IngressClass[] the items to be sorted (default: the current items in this store) sorting? (item: IngressClass) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_36","title":"Returns","text":"

IngressClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_30","title":"Parameters","text":"Name Type item IngressClass"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? IngressClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_32","title":"Parameters","text":"Name Type item IngressClass"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_33","title":"Parameters","text":"Name Type item IngressClass data PartialObjectDeep<IngressClass, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_41","title":"Returns","text":"

Promise<IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_34","title":"Parameters","text":"Name Type item IngressClass request () => Promise<IngressClass>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_43","title":"Returns","text":"

Promise<IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/","title":"Renderer.K8sApi.IngressStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / IngressStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#class-ingressstore","title":"Class: IngressStore","text":"

Renderer.K8sApi.IngressStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<Ingress, IngressApi>

\u21b3 IngressStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#constructor","title":"constructor","text":"

\u2022 new IngressStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api IngressApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<Ingress, IngressApi>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#api","title":"api","text":"

\u2022 Readonly api: IngressApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: Ingress) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_1","title":"Parameters","text":"Name Type item Ingress"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, IngressStatus, IngressSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#items","title":"items","text":"

\u2022 items: IObservableArray<Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<Ingress, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_4","title":"Returns","text":"

Generator<Ingress, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Ingress, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_6","title":"Returns","text":"

Promise<Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Ingress, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_7","title":"Returns","text":"

Promise<null | Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): Ingress[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_5","title":"Parameters","text":"Name Type items Ingress[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_8","title":"Returns","text":"

Ingress[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): Ingress[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_9","title":"Returns","text":"

Ingress[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | Ingress

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_10","title":"Returns","text":"

undefined | Ingress

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): Ingress[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_11","title":"Returns","text":"

Ingress[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | Ingress

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_12","title":"Returns","text":"

undefined | Ingress

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | Ingress

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_13","title":"Returns","text":"

undefined | Ingress

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): Ingress[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_15","title":"Returns","text":"

Ingress[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_12","title":"Parameters","text":"Name Type item Ingress"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? Ingress[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#load","title":"load","text":"

\u25b8 load(params): Promise<Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_19","title":"Returns","text":"

Promise<Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Ingress[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_20","title":"Returns","text":"

Promise<undefined | Ingress[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_21","title":"Returns","text":"

Promise<Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_22","title":"Returns","text":"

Promise<null | Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<Ingress[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_23","title":"Returns","text":"

Promise<Ingress[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Ingress[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_19","title":"Parameters","text":"Name Type partialItems Ingress[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_24","title":"Returns","text":"

Ingress[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_20","title":"Parameters","text":"Name Type item Ingress patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_25","title":"Returns","text":"

Promise<Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): Ingress[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_21","title":"Parameters","text":"Name Type items Ingress[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_26","title":"Returns","text":"

Ingress[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | Ingress[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_27","title":"Returns","text":"

Promise<undefined | Ingress[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_23","title":"Parameters","text":"Name Type item Ingress"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_24","title":"Parameters","text":"Name Type item Ingress request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_25","title":"Parameters","text":"Name Type items Ingress[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_27","title":"Parameters","text":"Name Type item Ingress"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): Ingress[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_28","title":"Parameters","text":"Name Type Description items? Ingress[] the items to be sorted (default: the current items in this store) sorting? (item: Ingress) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_36","title":"Returns","text":"

Ingress[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_30","title":"Parameters","text":"Name Type item Ingress"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? Ingress[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_32","title":"Parameters","text":"Name Type item Ingress"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_33","title":"Parameters","text":"Name Type item Ingress data PartialObjectDeep<Ingress, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_41","title":"Returns","text":"

Promise<Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_34","title":"Parameters","text":"Name Type item Ingress request () => Promise<Ingress>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_43","title":"Returns","text":"

Promise<Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/","title":"Renderer.K8sApi.JobStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / JobStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#class-jobstore","title":"Class: JobStore","text":"

Renderer.K8sApi.JobStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<Job, JobApi>

\u21b3 JobStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getChildPods
  • getIndexById
  • getItems
  • getJobsByOwner
  • getStatuses
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#constructor","title":"constructor","text":"

\u2022 new JobStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters","title":"Parameters","text":"Name Type dependencies Dependencies api JobApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#overrides","title":"Overrides","text":"

KubeObjectStore<Job, JobApi\\>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#api","title":"api","text":"

\u2022 Readonly api: JobApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: Job) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_1","title":"Parameters","text":"Name Type item Job"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: Dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#overrides_1","title":"Overrides","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, JobStatus, JobSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#items","title":"items","text":"

\u2022 items: IObservableArray<Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<Job, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_4","title":"Returns","text":"

Generator<Job, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Job, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_6","title":"Returns","text":"

Promise<Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Job, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_7","title":"Returns","text":"

Promise<null | Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_5","title":"Parameters","text":"Name Type items Job[]"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_8","title":"Returns","text":"

Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_9","title":"Returns","text":"

Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | Job

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_10","title":"Returns","text":"

undefined | Job

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_11","title":"Returns","text":"

Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | Job

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_12","title":"Returns","text":"

undefined | Job

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | Job

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_13","title":"Returns","text":"

undefined | Job

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getchildpods","title":"getChildPods","text":"

\u25b8 getChildPods(job): Pod[]

Deprecated

Switch to using getPodsByOwnerId directly

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_11","title":"Parameters","text":"Name Type job Job"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_14","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_12","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_16","title":"Returns","text":"

Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getjobsbyowner","title":"getJobsByOwner","text":"

\u25b8 getJobsByOwner(cronJob): Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_13","title":"Parameters","text":"Name Type cronJob CronJob"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_17","title":"Returns","text":"

Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getstatuses","title":"getStatuses","text":"

\u25b8 getStatuses(jobs?): Object

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_14","title":"Parameters","text":"Name Type jobs? Job[]"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_18","title":"Returns","text":"

Object

Name Type failed number pending number running number succeeded number"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_19","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_15","title":"Parameters","text":"Name Type item Job"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_20","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_16","title":"Parameters","text":"Name Type visibleItems? Job[]"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_21","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#load","title":"load","text":"

\u25b8 load(params): Promise<Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_22","title":"Returns","text":"

Promise<Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Job[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_23","title":"Returns","text":"

Promise<undefined | Job[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_19","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_24","title":"Returns","text":"

Promise<Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_20","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_25","title":"Returns","text":"

Promise<null | Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<Job[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_21","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_26","title":"Returns","text":"

Promise<Job[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_22","title":"Parameters","text":"Name Type partialItems Job[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_27","title":"Returns","text":"

Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_23","title":"Parameters","text":"Name Type item Job patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_28","title":"Returns","text":"

Promise<Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_24","title":"Parameters","text":"Name Type items Job[]"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_29","title":"Returns","text":"

Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | Job[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_25","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_30","title":"Returns","text":"

Promise<undefined | Job[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_26","title":"Parameters","text":"Name Type item Job"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_27","title":"Parameters","text":"Name Type item Job request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_32","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_28","title":"Parameters","text":"Name Type items Job[]"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_33","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_34","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_29","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_36","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_37","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_30","title":"Parameters","text":"Name Type item Job"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): Job[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_31","title":"Parameters","text":"Name Type Description items? Job[] the items to be sorted (default: the current items in this store) sorting? (item: Job) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_39","title":"Returns","text":"

Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_32","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_40","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_33","title":"Parameters","text":"Name Type item Job"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_41","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_34","title":"Parameters","text":"Name Type visibleItems? Job[]"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_35","title":"Parameters","text":"Name Type item Job"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_43","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_36","title":"Parameters","text":"Name Type item Job data PartialObjectDeep<Job, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_44","title":"Returns","text":"

Promise<Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_45","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_37","title":"Parameters","text":"Name Type item Job request () => Promise<Job>"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_46","title":"Returns","text":"

Promise<Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/","title":"Renderer.K8sApi.LimitRangesStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / LimitRangesStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#class-limitrangesstore","title":"Class: LimitRangesStore","text":"

Renderer.K8sApi.LimitRangesStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<LimitRange, LimitRangeApi>

\u21b3 LimitRangesStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#constructor","title":"constructor","text":"

\u2022 new LimitRangesStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api LimitRangeApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<LimitRange, LimitRangeApi>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#api","title":"api","text":"

\u2022 Readonly api: LimitRangeApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: LimitRange) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_1","title":"Parameters","text":"Name Type item LimitRange"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, void, LimitRangeSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#items","title":"items","text":"

\u2022 items: IObservableArray<LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<LimitRange, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_4","title":"Returns","text":"

Generator<LimitRange, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<LimitRange, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_6","title":"Returns","text":"

Promise<LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<LimitRange, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_7","title":"Returns","text":"

Promise<null | LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): LimitRange[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_5","title":"Parameters","text":"Name Type items LimitRange[]"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_8","title":"Returns","text":"

LimitRange[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): LimitRange[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_9","title":"Returns","text":"

LimitRange[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | LimitRange

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_10","title":"Returns","text":"

undefined | LimitRange

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): LimitRange[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_11","title":"Returns","text":"

LimitRange[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | LimitRange

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_12","title":"Returns","text":"

undefined | LimitRange

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | LimitRange

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_13","title":"Returns","text":"

undefined | LimitRange

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): LimitRange[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_15","title":"Returns","text":"

LimitRange[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_12","title":"Parameters","text":"Name Type item LimitRange"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? LimitRange[]"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#load","title":"load","text":"

\u25b8 load(params): Promise<LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_19","title":"Returns","text":"

Promise<LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | LimitRange[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_20","title":"Returns","text":"

Promise<undefined | LimitRange[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_21","title":"Returns","text":"

Promise<LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_22","title":"Returns","text":"

Promise<null | LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<LimitRange[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_23","title":"Returns","text":"

Promise<LimitRange[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): LimitRange[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_19","title":"Parameters","text":"Name Type partialItems LimitRange[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_24","title":"Returns","text":"

LimitRange[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_20","title":"Parameters","text":"Name Type item LimitRange patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_25","title":"Returns","text":"

Promise<LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): LimitRange[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_21","title":"Parameters","text":"Name Type items LimitRange[]"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_26","title":"Returns","text":"

LimitRange[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | LimitRange[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_27","title":"Returns","text":"

Promise<undefined | LimitRange[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_23","title":"Parameters","text":"Name Type item LimitRange"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_24","title":"Parameters","text":"Name Type item LimitRange request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_25","title":"Parameters","text":"Name Type items LimitRange[]"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_27","title":"Parameters","text":"Name Type item LimitRange"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): LimitRange[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_28","title":"Parameters","text":"Name Type Description items? LimitRange[] the items to be sorted (default: the current items in this store) sorting? (item: LimitRange) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_36","title":"Returns","text":"

LimitRange[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_30","title":"Parameters","text":"Name Type item LimitRange"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? LimitRange[]"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_32","title":"Parameters","text":"Name Type item LimitRange"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_33","title":"Parameters","text":"Name Type item LimitRange data PartialObjectDeep<LimitRange, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_41","title":"Returns","text":"

Promise<LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_34","title":"Parameters","text":"Name Type item LimitRange request () => Promise<LimitRange>"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_43","title":"Returns","text":"

Promise<LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/","title":"Renderer.K8sApi.NamespaceStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / NamespaceStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#class-namespacestore","title":"Class: NamespaceStore","text":"

Renderer.K8sApi.NamespaceStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<Namespace, NamespaceApi>

\u21b3 NamespaceStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectNamespaces
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#accessors","title":"Accessors","text":"
  • allowedNamespaces
  • areAllSelectedImplicitly
  • contextItems
  • contextNamespaces
  • hasAllContexts
  • query
  • selectedItems
  • selectedNames
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • clearSelected
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getNamespaceTree
  • getTotalCount
  • hasContext
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • onContextChange
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • selectAll
  • selectSingle
  • sortItems
  • subscribe
  • toggleAll
  • toggleContext
  • toggleSelection
  • toggleSelectionAll
  • toggleSingle
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#constructor","title":"constructor","text":"

\u2022 new NamespaceStore(dependencies, api)

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters","title":"Parameters","text":"Name Type dependencies Dependencies api NamespaceApi"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#overrides","title":"Overrides","text":"

KubeObjectStore<Namespace, NamespaceApi\\>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#api","title":"api","text":"

\u2022 Readonly api: NamespaceApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: Namespace) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_1","title":"Parameters","text":"Name Type item Namespace"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: Dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#overrides_1","title":"Overrides","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<ClusterScopedMetadata, NamespaceStatus, NamespaceSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#items","title":"items","text":"

\u2022 items: IObservableArray<Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selectnamespaces","title":"selectNamespaces","text":"

\u2022 selectNamespaces: (namespace: string | string[]) => void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (namespace): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_2","title":"Parameters","text":"Name Type namespace string | string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#allowednamespaces","title":"allowedNamespaces","text":"

\u2022 get allowedNamespaces(): string[]

Deprecated

This doesn't contain the namespaces from cluster settings or from cluster context

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_2","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#areallselectedimplicitly","title":"areAllSelectedImplicitly","text":"

\u2022 get areAllSelectedImplicitly(): boolean

Is true when the the set of namespace names selected is implicitly all

Namely, this will be true if the user has deselected all namespaces from the filter or if the user has clicked the \"All Namespaces\" option

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_3","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_4","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#contextnamespaces","title":"contextNamespaces","text":"

\u2022 get contextNamespaces(): string[]

The list of selected namespace names (for filtering)

Deprecated

This doesn't contain the namespaces from cluster settings or from cluster context

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_5","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#hasallcontexts","title":"hasAllContexts","text":"

\u2022 get hasAllContexts(): boolean

Is true if all available namespaces are selected, otherwise false

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_6","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_7","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_8","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selectednames","title":"selectedNames","text":"

\u2022 get selectedNames(): Set<string>

The set of select namespace names (for filtering)

Deprecated

This doesn't contain the namespaces from cluster settings or from cluster context

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_9","title":"Returns","text":"

Set<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<Namespace, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_10","title":"Returns","text":"

Generator<Namespace, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_3","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_11","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#clearselected","title":"clearSelected","text":"

\u25b8 clearSelected(namespaces?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_4","title":"Parameters","text":"Name Type namespaces? string | string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_12","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_5","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Namespace, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_13","title":"Returns","text":"

Promise<Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_6","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Namespace, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_14","title":"Returns","text":"

Promise<null | Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): Namespace[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_7","title":"Parameters","text":"Name Type items Namespace[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_15","title":"Returns","text":"

Namespace[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): Namespace[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_8","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_16","title":"Returns","text":"

Namespace[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | Namespace

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_9","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_17","title":"Returns","text":"

undefined | Namespace

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): Namespace[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_10","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_18","title":"Returns","text":"

Namespace[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | Namespace

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_11","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_19","title":"Returns","text":"

undefined | Namespace

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | Namespace

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_12","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_20","title":"Returns","text":"

undefined | Namespace

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_13","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_21","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): Namespace[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_22","title":"Returns","text":"

Namespace[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getnamespacetree","title":"getNamespaceTree","text":"

\u25b8 getNamespaceTree(root): NamespaceTree

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_14","title":"Parameters","text":"Name Type root Namespace"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_23","title":"Returns","text":"

NamespaceTree

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_24","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#hascontext","title":"hasContext","text":"

\u25b8 hasContext(namespaces): boolean

Checks if namespace names are selected for filtering

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_15","title":"Parameters","text":"Name Type Description namespaces string | string[] One or several names of namespaces to check if they are selected"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_25","title":"Returns","text":"

boolean

true if all the provided names are selected

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_16","title":"Parameters","text":"Name Type item Namespace"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_26","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_17","title":"Parameters","text":"Name Type visibleItems? Namespace[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_27","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#load","title":"load","text":"

\u25b8 load(params): Promise<Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_18","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_28","title":"Returns","text":"

Promise<Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Namespace[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_19","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_29","title":"Returns","text":"

Promise<undefined | Namespace[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_20","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_30","title":"Returns","text":"

Promise<Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_21","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_31","title":"Returns","text":"

Promise<null | Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(params): Promise<Namespace[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_22","title":"Parameters","text":"Name Type params KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_32","title":"Returns","text":"

Promise<Namespace[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#overrides_2","title":"Overrides","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Namespace[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_23","title":"Parameters","text":"Name Type partialItems Namespace[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_33","title":"Returns","text":"

Namespace[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#oncontextchange","title":"onContextChange","text":"

\u25b8 onContextChange(callback, opts?): IReactionDisposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_24","title":"Parameters","text":"Name Type callback (namespaces: string[]) => void opts? Object opts.fireImmediately? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_34","title":"Returns","text":"

IReactionDisposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_25","title":"Parameters","text":"Name Type item Namespace patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_35","title":"Returns","text":"

Promise<Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): Namespace[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_26","title":"Parameters","text":"Name Type items Namespace[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_36","title":"Returns","text":"

Namespace[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | Namespace[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_27","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_37","title":"Returns","text":"

Promise<undefined | Namespace[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_28","title":"Parameters","text":"Name Type item Namespace"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_38","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#overrides_3","title":"Overrides","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_29","title":"Parameters","text":"Name Type item Namespace request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_39","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_30","title":"Parameters","text":"Name Type items Namespace[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_40","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_41","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_31","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_43","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_44","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_32","title":"Parameters","text":"Name Type item Namespace"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_45","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selectall","title":"selectAll","text":"

\u25b8 selectAll(): void

Selects all available namespaces.

Note: If new namespaces appear in the future those will be selected too

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_46","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selectsingle","title":"selectSingle","text":"

\u25b8 selectSingle(namespace): void

Makes the given namespace the sole selected namespace

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_33","title":"Parameters","text":"Name Type namespace string"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_47","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): Namespace[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_34","title":"Parameters","text":"Name Type Description items? Namespace[] the items to be sorted (default: the current items in this store) sorting? (item: Namespace) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_48","title":"Returns","text":"

Namespace[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(): (...args: T) => void"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_49","title":"Returns","text":"

fn

\u25b8 <T>(...args): void

A function that does nothing

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#type-parameters","title":"Type parameters","text":"Name Type T extends any[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_35","title":"Parameters","text":"Name Type ...args T"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_50","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#overrides_4","title":"Overrides","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#toggleall","title":"toggleAll","text":"

\u25b8 toggleAll(selectAll?): void

This function selects all namespaces implicitly.

NOTE: does not toggle any namespaces

Deprecated

Use NamespaceStore.selectAll instead.

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_36","title":"Parameters","text":"Name Type Description selectAll? boolean NOT USED"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_51","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#togglecontext","title":"toggleContext","text":"

\u25b8 toggleContext(namespaces): void

Acts like toggleSingle but can work on several at a time

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_37","title":"Parameters","text":"Name Type Description namespaces string | string[] One or many names of namespaces to select"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_52","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_38","title":"Parameters","text":"Name Type item Namespace"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_53","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_39","title":"Parameters","text":"Name Type visibleItems? Namespace[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_54","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#togglesingle","title":"toggleSingle","text":"

\u25b8 toggleSingle(namespace): void

Toggles the selection state of namespace. Namely, if it was previously specifically or implicitly selected then after this call it will be explicitly deselected.

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_40","title":"Parameters","text":"Name Type Description namespace string The name of a namespace"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_55","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_41","title":"Parameters","text":"Name Type item Namespace"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_56","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_42","title":"Parameters","text":"Name Type item Namespace data PartialObjectDeep<Namespace, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_57","title":"Returns","text":"

Promise<Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_58","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_43","title":"Parameters","text":"Name Type item Namespace request () => Promise<Namespace>"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_59","title":"Returns","text":"

Promise<Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/","title":"Renderer.K8sApi.NetworkPolicyStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / NetworkPolicyStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#class-networkpolicystore","title":"Class: NetworkPolicyStore","text":"

Renderer.K8sApi.NetworkPolicyStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<NetworkPolicy, NetworkPolicyApi>

\u21b3 NetworkPolicyStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#constructor","title":"constructor","text":"

\u2022 new NetworkPolicyStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api NetworkPolicyApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<NetworkPolicy, NetworkPolicyApi>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#api","title":"api","text":"

\u2022 Readonly api: NetworkPolicyApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: NetworkPolicy) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_1","title":"Parameters","text":"Name Type item NetworkPolicy"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, void, NetworkPolicySpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#items","title":"items","text":"

\u2022 items: IObservableArray<NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<NetworkPolicy, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_4","title":"Returns","text":"

Generator<NetworkPolicy, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<NetworkPolicy, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_6","title":"Returns","text":"

Promise<NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<NetworkPolicy, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_7","title":"Returns","text":"

Promise<null | NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): NetworkPolicy[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_5","title":"Parameters","text":"Name Type items NetworkPolicy[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_8","title":"Returns","text":"

NetworkPolicy[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): NetworkPolicy[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_9","title":"Returns","text":"

NetworkPolicy[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | NetworkPolicy

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_10","title":"Returns","text":"

undefined | NetworkPolicy

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): NetworkPolicy[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_11","title":"Returns","text":"

NetworkPolicy[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | NetworkPolicy

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_12","title":"Returns","text":"

undefined | NetworkPolicy

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | NetworkPolicy

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_13","title":"Returns","text":"

undefined | NetworkPolicy

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): NetworkPolicy[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_15","title":"Returns","text":"

NetworkPolicy[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_12","title":"Parameters","text":"Name Type item NetworkPolicy"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? NetworkPolicy[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#load","title":"load","text":"

\u25b8 load(params): Promise<NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_19","title":"Returns","text":"

Promise<NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | NetworkPolicy[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_20","title":"Returns","text":"

Promise<undefined | NetworkPolicy[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_21","title":"Returns","text":"

Promise<NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_22","title":"Returns","text":"

Promise<null | NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<NetworkPolicy[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_23","title":"Returns","text":"

Promise<NetworkPolicy[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): NetworkPolicy[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_19","title":"Parameters","text":"Name Type partialItems NetworkPolicy[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_24","title":"Returns","text":"

NetworkPolicy[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_20","title":"Parameters","text":"Name Type item NetworkPolicy patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_25","title":"Returns","text":"

Promise<NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): NetworkPolicy[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_21","title":"Parameters","text":"Name Type items NetworkPolicy[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_26","title":"Returns","text":"

NetworkPolicy[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | NetworkPolicy[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_27","title":"Returns","text":"

Promise<undefined | NetworkPolicy[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_23","title":"Parameters","text":"Name Type item NetworkPolicy"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_24","title":"Parameters","text":"Name Type item NetworkPolicy request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_25","title":"Parameters","text":"Name Type items NetworkPolicy[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_27","title":"Parameters","text":"Name Type item NetworkPolicy"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): NetworkPolicy[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_28","title":"Parameters","text":"Name Type Description items? NetworkPolicy[] the items to be sorted (default: the current items in this store) sorting? (item: NetworkPolicy) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_36","title":"Returns","text":"

NetworkPolicy[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_30","title":"Parameters","text":"Name Type item NetworkPolicy"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? NetworkPolicy[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_32","title":"Parameters","text":"Name Type item NetworkPolicy"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_33","title":"Parameters","text":"Name Type item NetworkPolicy data PartialObjectDeep<NetworkPolicy, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_41","title":"Returns","text":"

Promise<NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_34","title":"Parameters","text":"Name Type item NetworkPolicy request () => Promise<NetworkPolicy>"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_43","title":"Returns","text":"

Promise<NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/","title":"Renderer.K8sApi.NodesStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / NodesStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#class-nodesstore","title":"Class: NodesStore","text":"

Renderer.K8sApi.NodesStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<Node, NodeApi>

\u21b3 NodesStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#accessors","title":"Accessors","text":"
  • contextItems
  • masterNodes
  • query
  • selectedItems
  • workerNodes
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • getWarningsCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#constructor","title":"constructor","text":"

\u2022 new NodesStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api NodeApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#overrides","title":"Overrides","text":"

KubeObjectStore<Node, NodeApi\\>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#api","title":"api","text":"

\u2022 Readonly api: NodeApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: Node) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_1","title":"Parameters","text":"Name Type item Node"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<ClusterScopedMetadata, NodeStatus, NodeSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#items","title":"items","text":"

\u2022 items: IObservableArray<Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#masternodes","title":"masterNodes","text":"

\u2022 get masterNodes(): Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_2","title":"Returns","text":"

Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_3","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_4","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#workernodes","title":"workerNodes","text":"

\u2022 get workerNodes(): Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_5","title":"Returns","text":"

Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<Node, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_6","title":"Returns","text":"

Generator<Node, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_7","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Node, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_8","title":"Returns","text":"

Promise<Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Node, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_9","title":"Returns","text":"

Promise<null | Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_5","title":"Parameters","text":"Name Type items Node[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_10","title":"Returns","text":"

Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_11","title":"Returns","text":"

Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | Node

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_12","title":"Returns","text":"

undefined | Node

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_13","title":"Returns","text":"

Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | Node

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_14","title":"Returns","text":"

undefined | Node

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | Node

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_15","title":"Returns","text":"

undefined | Node

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_17","title":"Returns","text":"

Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_18","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getwarningscount","title":"getWarningsCount","text":"

\u25b8 getWarningsCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_19","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_12","title":"Parameters","text":"Name Type item Node"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_20","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? Node[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_21","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#load","title":"load","text":"

\u25b8 load(params): Promise<Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_22","title":"Returns","text":"

Promise<Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Node[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_23","title":"Returns","text":"

Promise<undefined | Node[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_24","title":"Returns","text":"

Promise<Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_25","title":"Returns","text":"

Promise<null | Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<Node[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_26","title":"Returns","text":"

Promise<Node[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_19","title":"Parameters","text":"Name Type partialItems Node[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_27","title":"Returns","text":"

Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_20","title":"Parameters","text":"Name Type item Node patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_28","title":"Returns","text":"

Promise<Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_21","title":"Parameters","text":"Name Type items Node[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_29","title":"Returns","text":"

Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | Node[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_30","title":"Returns","text":"

Promise<undefined | Node[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_23","title":"Parameters","text":"Name Type item Node"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_24","title":"Parameters","text":"Name Type item Node request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_32","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_25","title":"Parameters","text":"Name Type items Node[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_33","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_34","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_36","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_37","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_27","title":"Parameters","text":"Name Type item Node"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): Node[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_28","title":"Parameters","text":"Name Type Description items? Node[] the items to be sorted (default: the current items in this store) sorting? (item: Node) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_39","title":"Returns","text":"

Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_40","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_30","title":"Parameters","text":"Name Type item Node"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_41","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? Node[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_32","title":"Parameters","text":"Name Type item Node"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_43","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_33","title":"Parameters","text":"Name Type item Node data PartialObjectDeep<Node, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_44","title":"Returns","text":"

Promise<Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_45","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_34","title":"Parameters","text":"Name Type item Node request () => Promise<Node>"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_46","title":"Returns","text":"

Promise<Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/","title":"Renderer.K8sApi.PersistentVolumesStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / PersistentVolumesStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#class-persistentvolumesstore","title":"Class: PersistentVolumesStore","text":"

Renderer.K8sApi.PersistentVolumesStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<PersistentVolume, PersistentVolumeApi>

\u21b3 PersistentVolumesStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getByStorageClass
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#constructor","title":"constructor","text":"

\u2022 new PersistentVolumesStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api PersistentVolumeApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<PersistentVolume, PersistentVolumeApi>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#api","title":"api","text":"

\u2022 Readonly api: PersistentVolumeApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: PersistentVolume) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_1","title":"Parameters","text":"Name Type item PersistentVolume"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<ClusterScopedMetadata, PersistentVolumeStatus, PersistentVolumeSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#items","title":"items","text":"

\u2022 items: IObservableArray<PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<PersistentVolume, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_4","title":"Returns","text":"

Generator<PersistentVolume, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<PersistentVolume, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_6","title":"Returns","text":"

Promise<PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<PersistentVolume, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_7","title":"Returns","text":"

Promise<null | PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_5","title":"Parameters","text":"Name Type items PersistentVolume[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_8","title":"Returns","text":"

PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_9","title":"Returns","text":"

PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | PersistentVolume

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_10","title":"Returns","text":"

undefined | PersistentVolume

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_11","title":"Returns","text":"

PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | PersistentVolume

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_12","title":"Returns","text":"

undefined | PersistentVolume

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | PersistentVolume

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_13","title":"Returns","text":"

undefined | PersistentVolume

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getbystorageclass","title":"getByStorageClass","text":"

\u25b8 getByStorageClass(storageClass): PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_11","title":"Parameters","text":"Name Type storageClass StorageClass"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_14","title":"Returns","text":"

PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_12","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_16","title":"Returns","text":"

PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_17","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_13","title":"Parameters","text":"Name Type item PersistentVolume"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_14","title":"Parameters","text":"Name Type visibleItems? PersistentVolume[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_19","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#load","title":"load","text":"

\u25b8 load(params): Promise<PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_15","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_20","title":"Returns","text":"

Promise<PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | PersistentVolume[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_16","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_21","title":"Returns","text":"

Promise<undefined | PersistentVolume[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_17","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_22","title":"Returns","text":"

Promise<PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_18","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_23","title":"Returns","text":"

Promise<null | PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<PersistentVolume[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_19","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_24","title":"Returns","text":"

Promise<PersistentVolume[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_20","title":"Parameters","text":"Name Type partialItems PersistentVolume[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_25","title":"Returns","text":"

PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_21","title":"Parameters","text":"Name Type item PersistentVolume patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_26","title":"Returns","text":"

Promise<PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_22","title":"Parameters","text":"Name Type items PersistentVolume[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_27","title":"Returns","text":"

PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | PersistentVolume[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_23","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_28","title":"Returns","text":"

Promise<undefined | PersistentVolume[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_24","title":"Parameters","text":"Name Type item PersistentVolume"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_25","title":"Parameters","text":"Name Type item PersistentVolume request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_26","title":"Parameters","text":"Name Type items PersistentVolume[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_32","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_27","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_28","title":"Parameters","text":"Name Type item PersistentVolume"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_36","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): PersistentVolume[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_29","title":"Parameters","text":"Name Type Description items? PersistentVolume[] the items to be sorted (default: the current items in this store) sorting? (item: PersistentVolume) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_37","title":"Returns","text":"

PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_30","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_38","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_31","title":"Parameters","text":"Name Type item PersistentVolume"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_32","title":"Parameters","text":"Name Type visibleItems? PersistentVolume[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_33","title":"Parameters","text":"Name Type item PersistentVolume"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_41","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_34","title":"Parameters","text":"Name Type item PersistentVolume data PartialObjectDeep<PersistentVolume, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_42","title":"Returns","text":"

Promise<PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_43","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_35","title":"Parameters","text":"Name Type item PersistentVolume request () => Promise<PersistentVolume>"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_44","title":"Returns","text":"

Promise<PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/","title":"Renderer.K8sApi.PodDisruptionBudgetsStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / PodDisruptionBudgetsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#class-poddisruptionbudgetsstore","title":"Class: PodDisruptionBudgetsStore","text":"

Renderer.K8sApi.PodDisruptionBudgetsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<PodDisruptionBudget, PodDisruptionBudgetApi>

\u21b3 PodDisruptionBudgetsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#constructor","title":"constructor","text":"

\u2022 new PodDisruptionBudgetsStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api PodDisruptionBudgetApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<PodDisruptionBudget, PodDisruptionBudgetApi>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#api","title":"api","text":"

\u2022 Readonly api: PodDisruptionBudgetApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: PodDisruptionBudget) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_1","title":"Parameters","text":"Name Type item PodDisruptionBudget"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, V1Beta1PodDisruptionBudgetStatus | V1PodDisruptionBudgetStatus, PodDisruptionBudgetSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#items","title":"items","text":"

\u2022 items: IObservableArray<PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<PodDisruptionBudget, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_4","title":"Returns","text":"

Generator<PodDisruptionBudget, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<PodDisruptionBudget, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_6","title":"Returns","text":"

Promise<PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<PodDisruptionBudget, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_7","title":"Returns","text":"

Promise<null | PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): PodDisruptionBudget[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_5","title":"Parameters","text":"Name Type items PodDisruptionBudget[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_8","title":"Returns","text":"

PodDisruptionBudget[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): PodDisruptionBudget[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_9","title":"Returns","text":"

PodDisruptionBudget[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | PodDisruptionBudget

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_10","title":"Returns","text":"

undefined | PodDisruptionBudget

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): PodDisruptionBudget[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_11","title":"Returns","text":"

PodDisruptionBudget[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | PodDisruptionBudget

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_12","title":"Returns","text":"

undefined | PodDisruptionBudget

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | PodDisruptionBudget

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_13","title":"Returns","text":"

undefined | PodDisruptionBudget

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): PodDisruptionBudget[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_15","title":"Returns","text":"

PodDisruptionBudget[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_12","title":"Parameters","text":"Name Type item PodDisruptionBudget"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? PodDisruptionBudget[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#load","title":"load","text":"

\u25b8 load(params): Promise<PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_19","title":"Returns","text":"

Promise<PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | PodDisruptionBudget[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_20","title":"Returns","text":"

Promise<undefined | PodDisruptionBudget[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_21","title":"Returns","text":"

Promise<PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_22","title":"Returns","text":"

Promise<null | PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<PodDisruptionBudget[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_23","title":"Returns","text":"

Promise<PodDisruptionBudget[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): PodDisruptionBudget[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_19","title":"Parameters","text":"Name Type partialItems PodDisruptionBudget[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_24","title":"Returns","text":"

PodDisruptionBudget[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_20","title":"Parameters","text":"Name Type item PodDisruptionBudget patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_25","title":"Returns","text":"

Promise<PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): PodDisruptionBudget[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_21","title":"Parameters","text":"Name Type items PodDisruptionBudget[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_26","title":"Returns","text":"

PodDisruptionBudget[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | PodDisruptionBudget[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_27","title":"Returns","text":"

Promise<undefined | PodDisruptionBudget[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_23","title":"Parameters","text":"Name Type item PodDisruptionBudget"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_24","title":"Parameters","text":"Name Type item PodDisruptionBudget request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_25","title":"Parameters","text":"Name Type items PodDisruptionBudget[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_27","title":"Parameters","text":"Name Type item PodDisruptionBudget"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): PodDisruptionBudget[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_28","title":"Parameters","text":"Name Type Description items? PodDisruptionBudget[] the items to be sorted (default: the current items in this store) sorting? (item: PodDisruptionBudget) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_36","title":"Returns","text":"

PodDisruptionBudget[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_30","title":"Parameters","text":"Name Type item PodDisruptionBudget"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? PodDisruptionBudget[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_32","title":"Parameters","text":"Name Type item PodDisruptionBudget"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_33","title":"Parameters","text":"Name Type item PodDisruptionBudget data PartialObjectDeep<PodDisruptionBudget, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_41","title":"Returns","text":"

Promise<PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_34","title":"Parameters","text":"Name Type item PodDisruptionBudget request () => Promise<PodDisruptionBudget>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_43","title":"Returns","text":"

Promise<PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/","title":"Renderer.K8sApi.PodsStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / PodsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#class-podsstore","title":"Class: PodsStore","text":"

Renderer.K8sApi.PodsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<Pod, PodApi>

\u21b3 PodsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • kubeMetrics
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getPodKubeMetrics
  • getPodsByNode
  • getPodsByOwner
  • getPodsByOwnerId
  • getStatuses
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • loadKubeMetrics
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#constructor","title":"constructor","text":"

\u2022 new PodsStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters","title":"Parameters","text":"Name Type dependencies PodStoreDependencies api PodApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#overrides","title":"Overrides","text":"

KubeObjectStore<Pod, PodApi\\>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#api","title":"api","text":"

\u2022 Readonly api: PodApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: Pod) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_1","title":"Parameters","text":"Name Type item Pod"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: PodStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#overrides_1","title":"Overrides","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, PodStatus, PodSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#items","title":"items","text":"

\u2022 items: IObservableArray<Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#kubemetrics","title":"kubeMetrics","text":"

\u2022 Readonly kubeMetrics: IObservableArray<PodMetrics>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<Pod, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_4","title":"Returns","text":"

Generator<Pod, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Pod, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_6","title":"Returns","text":"

Promise<Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Pod, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_7","title":"Returns","text":"

Promise<null | Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_5","title":"Parameters","text":"Name Type items Pod[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_8","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_9","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | Pod

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_10","title":"Returns","text":"

undefined | Pod

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_11","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | Pod

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_12","title":"Returns","text":"

undefined | Pod

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | Pod

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_13","title":"Returns","text":"

undefined | Pod

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_15","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getpodkubemetrics","title":"getPodKubeMetrics","text":"

\u25b8 getPodKubeMetrics(pod): Object

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_12","title":"Parameters","text":"Name Type pod Pod"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_16","title":"Returns","text":"

Object

Name Type cpu number memory number"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getpodsbynode","title":"getPodsByNode","text":"

\u25b8 getPodsByNode(node): Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_13","title":"Parameters","text":"Name Type node string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_17","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getpodsbyowner","title":"getPodsByOwner","text":"

\u25b8 getPodsByOwner(workload): Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_14","title":"Parameters","text":"Name Type workload KubeObject<NamespaceScopedMetadata, unknown, unknown>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_18","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getpodsbyownerid","title":"getPodsByOwnerId","text":"

\u25b8 getPodsByOwnerId(workloadId): Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_15","title":"Parameters","text":"Name Type workloadId string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_19","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getstatuses","title":"getStatuses","text":"

\u25b8 getStatuses(pods): Dictionary<number>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_16","title":"Parameters","text":"Name Type pods Pod[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_20","title":"Returns","text":"

Dictionary<number>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_21","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_17","title":"Parameters","text":"Name Type item Pod"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_22","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_18","title":"Parameters","text":"Name Type visibleItems? Pod[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_23","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#load","title":"load","text":"

\u25b8 load(params): Promise<Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_19","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_24","title":"Returns","text":"

Promise<Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Pod[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_20","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_25","title":"Returns","text":"

Promise<undefined | Pod[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_21","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_26","title":"Returns","text":"

Promise<Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_22","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_27","title":"Returns","text":"

Promise<null | Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<Pod[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_23","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_28","title":"Returns","text":"

Promise<Pod[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#loadkubemetrics","title":"loadKubeMetrics","text":"

\u25b8 loadKubeMetrics(namespace?): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_24","title":"Parameters","text":"Name Type namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_25","title":"Parameters","text":"Name Type partialItems Pod[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_30","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_26","title":"Parameters","text":"Name Type item Pod patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_31","title":"Returns","text":"

Promise<Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_27","title":"Parameters","text":"Name Type items Pod[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_32","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | Pod[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_28","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_33","title":"Returns","text":"

Promise<undefined | Pod[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_29","title":"Parameters","text":"Name Type item Pod"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_34","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_30","title":"Parameters","text":"Name Type item Pod request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_35","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_31","title":"Parameters","text":"Name Type items Pod[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_36","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_37","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_32","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_33","title":"Parameters","text":"Name Type item Pod"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_41","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): Pod[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_34","title":"Parameters","text":"Name Type Description items? Pod[] the items to be sorted (default: the current items in this store) sorting? (item: Pod) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_42","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_35","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_43","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_36","title":"Parameters","text":"Name Type item Pod"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_44","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_37","title":"Parameters","text":"Name Type visibleItems? Pod[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_45","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_38","title":"Parameters","text":"Name Type item Pod"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_46","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_39","title":"Parameters","text":"Name Type item Pod data PartialObjectDeep<Pod, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_47","title":"Returns","text":"

Promise<Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_48","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_40","title":"Parameters","text":"Name Type item Pod request () => Promise<Pod>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_49","title":"Returns","text":"

Promise<Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/","title":"Renderer.K8sApi.PriorityClassStoreStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / PriorityClassStoreStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#class-priorityclassstorestore","title":"Class: PriorityClassStoreStore","text":"

Renderer.K8sApi.PriorityClassStoreStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<PriorityClass, PriorityClassApi>

\u21b3 PriorityClassStoreStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#constructor","title":"constructor","text":"

\u2022 new PriorityClassStoreStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api PriorityClassApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<PriorityClass, PriorityClassApi>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#api","title":"api","text":"

\u2022 Readonly api: PriorityClassApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: PriorityClass) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_1","title":"Parameters","text":"Name Type item PriorityClass"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<PriorityClassData>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#items","title":"items","text":"

\u2022 items: IObservableArray<PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<PriorityClass, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_4","title":"Returns","text":"

Generator<PriorityClass, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<PriorityClass, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_6","title":"Returns","text":"

Promise<PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<PriorityClass, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_7","title":"Returns","text":"

Promise<null | PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): PriorityClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_5","title":"Parameters","text":"Name Type items PriorityClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_8","title":"Returns","text":"

PriorityClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): PriorityClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_9","title":"Returns","text":"

PriorityClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | PriorityClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_10","title":"Returns","text":"

undefined | PriorityClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): PriorityClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_11","title":"Returns","text":"

PriorityClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | PriorityClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_12","title":"Returns","text":"

undefined | PriorityClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | PriorityClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_13","title":"Returns","text":"

undefined | PriorityClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): PriorityClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_15","title":"Returns","text":"

PriorityClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_12","title":"Parameters","text":"Name Type item PriorityClass"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? PriorityClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#load","title":"load","text":"

\u25b8 load(params): Promise<PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_19","title":"Returns","text":"

Promise<PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | PriorityClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_20","title":"Returns","text":"

Promise<undefined | PriorityClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_21","title":"Returns","text":"

Promise<PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_22","title":"Returns","text":"

Promise<null | PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<PriorityClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_23","title":"Returns","text":"

Promise<PriorityClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): PriorityClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_19","title":"Parameters","text":"Name Type partialItems PriorityClass[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_24","title":"Returns","text":"

PriorityClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_20","title":"Parameters","text":"Name Type item PriorityClass patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_25","title":"Returns","text":"

Promise<PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): PriorityClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_21","title":"Parameters","text":"Name Type items PriorityClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_26","title":"Returns","text":"

PriorityClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | PriorityClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_27","title":"Returns","text":"

Promise<undefined | PriorityClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_23","title":"Parameters","text":"Name Type item PriorityClass"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_24","title":"Parameters","text":"Name Type item PriorityClass request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_25","title":"Parameters","text":"Name Type items PriorityClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_27","title":"Parameters","text":"Name Type item PriorityClass"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): PriorityClass[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_28","title":"Parameters","text":"Name Type Description items? PriorityClass[] the items to be sorted (default: the current items in this store) sorting? (item: PriorityClass) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_36","title":"Returns","text":"

PriorityClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_30","title":"Parameters","text":"Name Type item PriorityClass"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? PriorityClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_32","title":"Parameters","text":"Name Type item PriorityClass"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_33","title":"Parameters","text":"Name Type item PriorityClass data PartialObjectDeep<PriorityClass, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_41","title":"Returns","text":"

Promise<PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_34","title":"Parameters","text":"Name Type item PriorityClass request () => Promise<PriorityClass>"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_43","title":"Returns","text":"

Promise<PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/","title":"Renderer.K8sApi.ReplicaSetStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / ReplicaSetStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#class-replicasetstore","title":"Class: ReplicaSetStore","text":"

Renderer.K8sApi.ReplicaSetStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<ReplicaSet, ReplicaSetApi>

\u21b3 ReplicaSetStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getChildPods
  • getIndexById
  • getItems
  • getReplicaSetsByOwner
  • getStatuses
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#constructor","title":"constructor","text":"

\u2022 new ReplicaSetStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters","title":"Parameters","text":"Name Type dependencies ReplicaSetStoreDependencies api ReplicaSetApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#overrides","title":"Overrides","text":"

KubeObjectStore<ReplicaSet, ReplicaSetApi\\>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#api","title":"api","text":"

\u2022 Readonly api: ReplicaSetApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: ReplicaSet) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_1","title":"Parameters","text":"Name Type item ReplicaSet"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: ReplicaSetStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#overrides_1","title":"Overrides","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, ReplicaSetStatus, ReplicaSetSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#items","title":"items","text":"

\u2022 items: IObservableArray<ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<ReplicaSet, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_4","title":"Returns","text":"

Generator<ReplicaSet, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<ReplicaSet, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_6","title":"Returns","text":"

Promise<ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<ReplicaSet, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_7","title":"Returns","text":"

Promise<null | ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_5","title":"Parameters","text":"Name Type items ReplicaSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_8","title":"Returns","text":"

ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_9","title":"Returns","text":"

ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | ReplicaSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_10","title":"Returns","text":"

undefined | ReplicaSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_11","title":"Returns","text":"

ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | ReplicaSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_12","title":"Returns","text":"

undefined | ReplicaSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | ReplicaSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_13","title":"Returns","text":"

undefined | ReplicaSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getchildpods","title":"getChildPods","text":"

\u25b8 getChildPods(replicaSet): Pod[]

Deprecated

Switch to using getPodsByOwnerId directly

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_11","title":"Parameters","text":"Name Type replicaSet ReplicaSet"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_14","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_12","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_16","title":"Returns","text":"

ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getreplicasetsbyowner","title":"getReplicaSetsByOwner","text":"

\u25b8 getReplicaSetsByOwner(deployment): ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_13","title":"Parameters","text":"Name Type deployment Deployment"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_17","title":"Returns","text":"

ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getstatuses","title":"getStatuses","text":"

\u25b8 getStatuses(replicaSets): Object

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_14","title":"Parameters","text":"Name Type replicaSets ReplicaSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_18","title":"Returns","text":"

Object

Name Type failed number pending number running number"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_19","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_15","title":"Parameters","text":"Name Type item ReplicaSet"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_20","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_16","title":"Parameters","text":"Name Type visibleItems? ReplicaSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_21","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#load","title":"load","text":"

\u25b8 load(params): Promise<ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_22","title":"Returns","text":"

Promise<ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | ReplicaSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_23","title":"Returns","text":"

Promise<undefined | ReplicaSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_19","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_24","title":"Returns","text":"

Promise<ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_20","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_25","title":"Returns","text":"

Promise<null | ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<ReplicaSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_21","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_26","title":"Returns","text":"

Promise<ReplicaSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_22","title":"Parameters","text":"Name Type partialItems ReplicaSet[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_27","title":"Returns","text":"

ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_23","title":"Parameters","text":"Name Type item ReplicaSet patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_28","title":"Returns","text":"

Promise<ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_24","title":"Parameters","text":"Name Type items ReplicaSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_29","title":"Returns","text":"

ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | ReplicaSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_25","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_30","title":"Returns","text":"

Promise<undefined | ReplicaSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_26","title":"Parameters","text":"Name Type item ReplicaSet"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_27","title":"Parameters","text":"Name Type item ReplicaSet request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_32","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_28","title":"Parameters","text":"Name Type items ReplicaSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_33","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_34","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_29","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_36","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_37","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_30","title":"Parameters","text":"Name Type item ReplicaSet"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): ReplicaSet[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_31","title":"Parameters","text":"Name Type Description items? ReplicaSet[] the items to be sorted (default: the current items in this store) sorting? (item: ReplicaSet) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_39","title":"Returns","text":"

ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_32","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_40","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_33","title":"Parameters","text":"Name Type item ReplicaSet"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_41","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_34","title":"Parameters","text":"Name Type visibleItems? ReplicaSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_35","title":"Parameters","text":"Name Type item ReplicaSet"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_43","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_36","title":"Parameters","text":"Name Type item ReplicaSet data PartialObjectDeep<ReplicaSet, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_44","title":"Returns","text":"

Promise<ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_45","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_37","title":"Parameters","text":"Name Type item ReplicaSet request () => Promise<ReplicaSet>"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_46","title":"Returns","text":"

Promise<ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/","title":"Renderer.K8sApi.ResourceQuotasStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / ResourceQuotasStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#class-resourcequotasstore","title":"Class: ResourceQuotasStore","text":"

Renderer.K8sApi.ResourceQuotasStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<ResourceQuota, ResourceQuotaApi>

\u21b3 ResourceQuotasStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#constructor","title":"constructor","text":"

\u2022 new ResourceQuotasStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api ResourceQuotaApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<ResourceQuota, ResourceQuotaApi>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#api","title":"api","text":"

\u2022 Readonly api: ResourceQuotaApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: ResourceQuota) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_1","title":"Parameters","text":"Name Type item ResourceQuota"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, ResourceQuotaStatus, ResourceQuotaSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#items","title":"items","text":"

\u2022 items: IObservableArray<ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<ResourceQuota, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_4","title":"Returns","text":"

Generator<ResourceQuota, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<ResourceQuota, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_6","title":"Returns","text":"

Promise<ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<ResourceQuota, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_7","title":"Returns","text":"

Promise<null | ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): ResourceQuota[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_5","title":"Parameters","text":"Name Type items ResourceQuota[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_8","title":"Returns","text":"

ResourceQuota[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): ResourceQuota[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_9","title":"Returns","text":"

ResourceQuota[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | ResourceQuota

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_10","title":"Returns","text":"

undefined | ResourceQuota

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): ResourceQuota[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_11","title":"Returns","text":"

ResourceQuota[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | ResourceQuota

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_12","title":"Returns","text":"

undefined | ResourceQuota

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | ResourceQuota

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_13","title":"Returns","text":"

undefined | ResourceQuota

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): ResourceQuota[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_15","title":"Returns","text":"

ResourceQuota[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_12","title":"Parameters","text":"Name Type item ResourceQuota"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? ResourceQuota[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#load","title":"load","text":"

\u25b8 load(params): Promise<ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_19","title":"Returns","text":"

Promise<ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | ResourceQuota[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_20","title":"Returns","text":"

Promise<undefined | ResourceQuota[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_21","title":"Returns","text":"

Promise<ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_22","title":"Returns","text":"

Promise<null | ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<ResourceQuota[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_23","title":"Returns","text":"

Promise<ResourceQuota[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): ResourceQuota[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_19","title":"Parameters","text":"Name Type partialItems ResourceQuota[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_24","title":"Returns","text":"

ResourceQuota[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_20","title":"Parameters","text":"Name Type item ResourceQuota patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_25","title":"Returns","text":"

Promise<ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): ResourceQuota[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_21","title":"Parameters","text":"Name Type items ResourceQuota[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_26","title":"Returns","text":"

ResourceQuota[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | ResourceQuota[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_27","title":"Returns","text":"

Promise<undefined | ResourceQuota[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_23","title":"Parameters","text":"Name Type item ResourceQuota"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_24","title":"Parameters","text":"Name Type item ResourceQuota request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_25","title":"Parameters","text":"Name Type items ResourceQuota[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_27","title":"Parameters","text":"Name Type item ResourceQuota"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): ResourceQuota[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_28","title":"Parameters","text":"Name Type Description items? ResourceQuota[] the items to be sorted (default: the current items in this store) sorting? (item: ResourceQuota) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_36","title":"Returns","text":"

ResourceQuota[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_30","title":"Parameters","text":"Name Type item ResourceQuota"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? ResourceQuota[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_32","title":"Parameters","text":"Name Type item ResourceQuota"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_33","title":"Parameters","text":"Name Type item ResourceQuota data PartialObjectDeep<ResourceQuota, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_41","title":"Returns","text":"

Promise<ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_34","title":"Parameters","text":"Name Type item ResourceQuota request () => Promise<ResourceQuota>"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_43","title":"Returns","text":"

Promise<ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/","title":"Renderer.K8sApi.RoleBindingsStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / RoleBindingsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#class-rolebindingsstore","title":"Class: RoleBindingsStore","text":"

Renderer.K8sApi.RoleBindingsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<RoleBinding, RoleBindingApi, RoleBindingData>

\u21b3 RoleBindingsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • removeSubjects
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
  • updateSubjects
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#constructor","title":"constructor","text":"

\u2022 new RoleBindingsStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api RoleBindingApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<RoleBinding, RoleBindingApi, RoleBindingData>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#api","title":"api","text":"

\u2022 Readonly api: RoleBindingApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: RoleBinding) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_1","title":"Parameters","text":"Name Type item RoleBinding"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<RoleBindingData>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#items","title":"items","text":"

\u2022 items: IObservableArray<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<RoleBinding, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_4","title":"Returns","text":"

Generator<RoleBinding, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<RoleBinding, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_6","title":"Returns","text":"

Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<RoleBinding, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_7","title":"Returns","text":"

Promise<null | RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): RoleBinding[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_5","title":"Parameters","text":"Name Type items RoleBinding[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_8","title":"Returns","text":"

RoleBinding[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): RoleBinding[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_9","title":"Returns","text":"

RoleBinding[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | RoleBinding

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_10","title":"Returns","text":"

undefined | RoleBinding

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): RoleBinding[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_11","title":"Returns","text":"

RoleBinding[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | RoleBinding

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_12","title":"Returns","text":"

undefined | RoleBinding

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | RoleBinding

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_13","title":"Returns","text":"

undefined | RoleBinding

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): RoleBinding[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_15","title":"Returns","text":"

RoleBinding[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_12","title":"Parameters","text":"Name Type item RoleBinding"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? RoleBinding[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#load","title":"load","text":"

\u25b8 load(params): Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_19","title":"Returns","text":"

Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | RoleBinding[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_20","title":"Returns","text":"

Promise<undefined | RoleBinding[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_21","title":"Returns","text":"

Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_22","title":"Returns","text":"

Promise<null | RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<RoleBinding[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_23","title":"Returns","text":"

Promise<RoleBinding[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): RoleBinding[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_19","title":"Parameters","text":"Name Type partialItems RoleBinding[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_24","title":"Returns","text":"

RoleBinding[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_20","title":"Parameters","text":"Name Type item RoleBinding patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_25","title":"Returns","text":"

Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): RoleBinding[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_21","title":"Parameters","text":"Name Type items RoleBinding[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_26","title":"Returns","text":"

RoleBinding[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | RoleBinding[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_27","title":"Returns","text":"

Promise<undefined | RoleBinding[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_23","title":"Parameters","text":"Name Type item RoleBinding"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_24","title":"Parameters","text":"Name Type item RoleBinding request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_25","title":"Parameters","text":"Name Type items RoleBinding[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#removesubjects","title":"removeSubjects","text":"

\u25b8 removeSubjects(roleBinding, subjectsToRemove): Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_26","title":"Parameters","text":"Name Type roleBinding RoleBinding subjectsToRemove Iterable<Subject>"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_32","title":"Returns","text":"

Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_27","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_28","title":"Parameters","text":"Name Type item RoleBinding"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_36","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items): RoleBinding[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_29","title":"Parameters","text":"Name Type items RoleBinding[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_37","title":"Returns","text":"

RoleBinding[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#overrides","title":"Overrides","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_30","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_38","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_31","title":"Parameters","text":"Name Type item RoleBinding"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_32","title":"Parameters","text":"Name Type visibleItems? RoleBinding[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_33","title":"Parameters","text":"Name Type item RoleBinding"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_41","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_34","title":"Parameters","text":"Name Type item RoleBinding data PartialObjectDeep<RoleBinding, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_42","title":"Returns","text":"

Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_43","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_35","title":"Parameters","text":"Name Type item RoleBinding request () => Promise<RoleBinding>"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_44","title":"Returns","text":"

Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#updatesubjects","title":"updateSubjects","text":"

\u25b8 updateSubjects(roleBinding, subjects): Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_36","title":"Parameters","text":"Name Type roleBinding RoleBinding subjects Subject[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_45","title":"Returns","text":"

Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/","title":"Renderer.K8sApi.RolesStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / RolesStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#class-rolesstore","title":"Class: RolesStore","text":"

Renderer.K8sApi.RolesStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<Role, RoleApi, RoleData>

\u21b3 RolesStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#constructor","title":"constructor","text":"

\u2022 new RolesStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api RoleApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<Role, RoleApi, RoleData>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#api","title":"api","text":"

\u2022 Readonly api: RoleApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: Role) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_1","title":"Parameters","text":"Name Type item Role"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<RoleData>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#items","title":"items","text":"

\u2022 items: IObservableArray<Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<Role, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_4","title":"Returns","text":"

Generator<Role, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Role, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_6","title":"Returns","text":"

Promise<Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Role, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_7","title":"Returns","text":"

Promise<null | Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): Role[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_5","title":"Parameters","text":"Name Type items Role[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_8","title":"Returns","text":"

Role[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): Role[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_9","title":"Returns","text":"

Role[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | Role

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_10","title":"Returns","text":"

undefined | Role

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): Role[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_11","title":"Returns","text":"

Role[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | Role

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_12","title":"Returns","text":"

undefined | Role

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | Role

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_13","title":"Returns","text":"

undefined | Role

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): Role[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_15","title":"Returns","text":"

Role[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_12","title":"Parameters","text":"Name Type item Role"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? Role[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#load","title":"load","text":"

\u25b8 load(params): Promise<Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_19","title":"Returns","text":"

Promise<Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Role[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_20","title":"Returns","text":"

Promise<undefined | Role[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_21","title":"Returns","text":"

Promise<Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_22","title":"Returns","text":"

Promise<null | Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<Role[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_23","title":"Returns","text":"

Promise<Role[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Role[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_19","title":"Parameters","text":"Name Type partialItems Role[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_24","title":"Returns","text":"

Role[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_20","title":"Parameters","text":"Name Type item Role patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_25","title":"Returns","text":"

Promise<Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): Role[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_21","title":"Parameters","text":"Name Type items Role[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_26","title":"Returns","text":"

Role[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | Role[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_27","title":"Returns","text":"

Promise<undefined | Role[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_23","title":"Parameters","text":"Name Type item Role"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_24","title":"Parameters","text":"Name Type item Role request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_25","title":"Parameters","text":"Name Type items Role[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_27","title":"Parameters","text":"Name Type item Role"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items): Role[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_28","title":"Parameters","text":"Name Type items Role[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_36","title":"Returns","text":"

Role[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#overrides","title":"Overrides","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_30","title":"Parameters","text":"Name Type item Role"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? Role[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_32","title":"Parameters","text":"Name Type item Role"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_33","title":"Parameters","text":"Name Type item Role data PartialObjectDeep<Role, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_41","title":"Returns","text":"

Promise<Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_34","title":"Parameters","text":"Name Type item Role request () => Promise<Role>"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_43","title":"Returns","text":"

Promise<Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/","title":"Renderer.K8sApi.SecretsStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / SecretsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#class-secretsstore","title":"Class: SecretsStore","text":"

Renderer.K8sApi.SecretsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<Secret, SecretApi, SecretData>

\u21b3 SecretsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#constructor","title":"constructor","text":"

\u2022 new SecretsStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api SecretApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<Secret, SecretApi, SecretData>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#api","title":"api","text":"

\u2022 Readonly api: SecretApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: Secret) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_1","title":"Parameters","text":"Name Type item Secret"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<SecretData>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#items","title":"items","text":"

\u2022 items: IObservableArray<Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<Secret, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_4","title":"Returns","text":"

Generator<Secret, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Secret, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_6","title":"Returns","text":"

Promise<Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Secret, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_7","title":"Returns","text":"

Promise<null | Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): Secret[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_5","title":"Parameters","text":"Name Type items Secret[]"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_8","title":"Returns","text":"

Secret[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): Secret[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_9","title":"Returns","text":"

Secret[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | Secret

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_10","title":"Returns","text":"

undefined | Secret

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): Secret[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_11","title":"Returns","text":"

Secret[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | Secret

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_12","title":"Returns","text":"

undefined | Secret

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | Secret

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_13","title":"Returns","text":"

undefined | Secret

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): Secret[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_15","title":"Returns","text":"

Secret[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_12","title":"Parameters","text":"Name Type item Secret"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? Secret[]"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#load","title":"load","text":"

\u25b8 load(params): Promise<Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_19","title":"Returns","text":"

Promise<Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Secret[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_20","title":"Returns","text":"

Promise<undefined | Secret[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_21","title":"Returns","text":"

Promise<Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_22","title":"Returns","text":"

Promise<null | Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<Secret[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_23","title":"Returns","text":"

Promise<Secret[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Secret[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_19","title":"Parameters","text":"Name Type partialItems Secret[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_24","title":"Returns","text":"

Secret[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_20","title":"Parameters","text":"Name Type item Secret patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_25","title":"Returns","text":"

Promise<Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): Secret[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_21","title":"Parameters","text":"Name Type items Secret[]"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_26","title":"Returns","text":"

Secret[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | Secret[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_27","title":"Returns","text":"

Promise<undefined | Secret[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_23","title":"Parameters","text":"Name Type item Secret"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_24","title":"Parameters","text":"Name Type item Secret request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_25","title":"Parameters","text":"Name Type items Secret[]"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_27","title":"Parameters","text":"Name Type item Secret"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): Secret[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_28","title":"Parameters","text":"Name Type Description items? Secret[] the items to be sorted (default: the current items in this store) sorting? (item: Secret) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_36","title":"Returns","text":"

Secret[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_30","title":"Parameters","text":"Name Type item Secret"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? Secret[]"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_32","title":"Parameters","text":"Name Type item Secret"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_33","title":"Parameters","text":"Name Type item Secret data PartialObjectDeep<Secret, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_41","title":"Returns","text":"

Promise<Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_34","title":"Parameters","text":"Name Type item Secret request () => Promise<Secret>"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_43","title":"Returns","text":"

Promise<Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/","title":"Renderer.K8sApi.ServiceAccountsStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / ServiceAccountsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#class-serviceaccountsstore","title":"Class: ServiceAccountsStore","text":"

Renderer.K8sApi.ServiceAccountsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<ServiceAccount, ServiceAccountApi, ServiceAccountData>

\u21b3 ServiceAccountsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#constructor","title":"constructor","text":"

\u2022 new ServiceAccountsStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api ServiceAccountApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<ServiceAccount, ServiceAccountApi, ServiceAccountData>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#api","title":"api","text":"

\u2022 Readonly api: ServiceAccountApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: ServiceAccount) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_1","title":"Parameters","text":"Name Type item ServiceAccount"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<ServiceAccountData>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#items","title":"items","text":"

\u2022 items: IObservableArray<ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<ServiceAccount, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_4","title":"Returns","text":"

Generator<ServiceAccount, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<ServiceAccount, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_6","title":"Returns","text":"

Promise<ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params): Promise<null | ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_7","title":"Returns","text":"

Promise<null | ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#overrides","title":"Overrides","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): ServiceAccount[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_5","title":"Parameters","text":"Name Type items ServiceAccount[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_8","title":"Returns","text":"

ServiceAccount[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): ServiceAccount[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_9","title":"Returns","text":"

ServiceAccount[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | ServiceAccount

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_10","title":"Returns","text":"

undefined | ServiceAccount

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): ServiceAccount[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_11","title":"Returns","text":"

ServiceAccount[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | ServiceAccount

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_12","title":"Returns","text":"

undefined | ServiceAccount

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | ServiceAccount

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_13","title":"Returns","text":"

undefined | ServiceAccount

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): ServiceAccount[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_15","title":"Returns","text":"

ServiceAccount[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_12","title":"Parameters","text":"Name Type item ServiceAccount"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? ServiceAccount[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#load","title":"load","text":"

\u25b8 load(params): Promise<ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_19","title":"Returns","text":"

Promise<ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | ServiceAccount[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_20","title":"Returns","text":"

Promise<undefined | ServiceAccount[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_21","title":"Returns","text":"

Promise<ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_22","title":"Returns","text":"

Promise<null | ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<ServiceAccount[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_23","title":"Returns","text":"

Promise<ServiceAccount[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): ServiceAccount[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_19","title":"Parameters","text":"Name Type partialItems ServiceAccount[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_24","title":"Returns","text":"

ServiceAccount[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_20","title":"Parameters","text":"Name Type item ServiceAccount patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_25","title":"Returns","text":"

Promise<ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): ServiceAccount[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_21","title":"Parameters","text":"Name Type items ServiceAccount[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_26","title":"Returns","text":"

ServiceAccount[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | ServiceAccount[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_27","title":"Returns","text":"

Promise<undefined | ServiceAccount[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_23","title":"Parameters","text":"Name Type item ServiceAccount"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_24","title":"Parameters","text":"Name Type item ServiceAccount request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_25","title":"Parameters","text":"Name Type items ServiceAccount[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_27","title":"Parameters","text":"Name Type item ServiceAccount"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): ServiceAccount[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_28","title":"Parameters","text":"Name Type Description items? ServiceAccount[] the items to be sorted (default: the current items in this store) sorting? (item: ServiceAccount) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_36","title":"Returns","text":"

ServiceAccount[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_30","title":"Parameters","text":"Name Type item ServiceAccount"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? ServiceAccount[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_32","title":"Parameters","text":"Name Type item ServiceAccount"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_33","title":"Parameters","text":"Name Type item ServiceAccount data PartialObjectDeep<ServiceAccount, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_41","title":"Returns","text":"

Promise<ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_34","title":"Parameters","text":"Name Type item ServiceAccount request () => Promise<ServiceAccount>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_43","title":"Returns","text":"

Promise<ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/","title":"Renderer.K8sApi.ServiceStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / ServiceStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#class-servicestore","title":"Class: ServiceStore","text":"

Renderer.K8sApi.ServiceStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<Service, ServiceApi>

\u21b3 ServiceStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#constructor","title":"constructor","text":"

\u2022 new ServiceStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api ServiceApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<Service, ServiceApi>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#api","title":"api","text":"

\u2022 Readonly api: ServiceApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: Service) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_1","title":"Parameters","text":"Name Type item Service"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, ServiceStatus, ServiceSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#items","title":"items","text":"

\u2022 items: IObservableArray<Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<Service, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_4","title":"Returns","text":"

Generator<Service, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Service, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_6","title":"Returns","text":"

Promise<Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Service, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_7","title":"Returns","text":"

Promise<null | Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): Service[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_5","title":"Parameters","text":"Name Type items Service[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_8","title":"Returns","text":"

Service[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): Service[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_9","title":"Returns","text":"

Service[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | Service

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_10","title":"Returns","text":"

undefined | Service

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): Service[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_11","title":"Returns","text":"

Service[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | Service

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_12","title":"Returns","text":"

undefined | Service

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | Service

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_13","title":"Returns","text":"

undefined | Service

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): Service[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_15","title":"Returns","text":"

Service[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_12","title":"Parameters","text":"Name Type item Service"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? Service[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#load","title":"load","text":"

\u25b8 load(params): Promise<Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_19","title":"Returns","text":"

Promise<Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Service[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_20","title":"Returns","text":"

Promise<undefined | Service[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_21","title":"Returns","text":"

Promise<Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_22","title":"Returns","text":"

Promise<null | Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<Service[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_23","title":"Returns","text":"

Promise<Service[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Service[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_19","title":"Parameters","text":"Name Type partialItems Service[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_24","title":"Returns","text":"

Service[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_20","title":"Parameters","text":"Name Type item Service patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_25","title":"Returns","text":"

Promise<Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): Service[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_21","title":"Parameters","text":"Name Type items Service[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_26","title":"Returns","text":"

Service[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | Service[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_27","title":"Returns","text":"

Promise<undefined | Service[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_23","title":"Parameters","text":"Name Type item Service"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_24","title":"Parameters","text":"Name Type item Service request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_25","title":"Parameters","text":"Name Type items Service[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_27","title":"Parameters","text":"Name Type item Service"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): Service[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_28","title":"Parameters","text":"Name Type Description items? Service[] the items to be sorted (default: the current items in this store) sorting? (item: Service) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_36","title":"Returns","text":"

Service[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_30","title":"Parameters","text":"Name Type item Service"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? Service[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_32","title":"Parameters","text":"Name Type item Service"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_33","title":"Parameters","text":"Name Type item Service data PartialObjectDeep<Service, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_41","title":"Returns","text":"

Promise<Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_34","title":"Parameters","text":"Name Type item Service request () => Promise<Service>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_43","title":"Returns","text":"

Promise<Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/","title":"Renderer.K8sApi.StatefulSetStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / StatefulSetStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#class-statefulsetstore","title":"Class: StatefulSetStore","text":"

Renderer.K8sApi.StatefulSetStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<StatefulSet, StatefulSetApi>

\u21b3 StatefulSetStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getChildPods
  • getIndexById
  • getItems
  • getStatuses
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#constructor","title":"constructor","text":"

\u2022 new StatefulSetStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters","title":"Parameters","text":"Name Type dependencies Dependencies api StatefulSetApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#overrides","title":"Overrides","text":"

KubeObjectStore<StatefulSet, StatefulSetApi\\>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#api","title":"api","text":"

\u2022 Readonly api: StatefulSetApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: StatefulSet) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_1","title":"Parameters","text":"Name Type item StatefulSet"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: Dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#overrides_1","title":"Overrides","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, StatefulSetStatus, StatefulSetSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#items","title":"items","text":"

\u2022 items: IObservableArray<StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<StatefulSet, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_4","title":"Returns","text":"

Generator<StatefulSet, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<StatefulSet, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_6","title":"Returns","text":"

Promise<StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<StatefulSet, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_7","title":"Returns","text":"

Promise<null | StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): StatefulSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_5","title":"Parameters","text":"Name Type items StatefulSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_8","title":"Returns","text":"

StatefulSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): StatefulSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_9","title":"Returns","text":"

StatefulSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | StatefulSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_10","title":"Returns","text":"

undefined | StatefulSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): StatefulSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_11","title":"Returns","text":"

StatefulSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | StatefulSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_12","title":"Returns","text":"

undefined | StatefulSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | StatefulSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_13","title":"Returns","text":"

undefined | StatefulSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getchildpods","title":"getChildPods","text":"

\u25b8 getChildPods(statefulSet): Pod[]

Deprecated

Switch to using getPodsByOwnerId directly

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_11","title":"Parameters","text":"Name Type statefulSet StatefulSet"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_14","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_12","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): StatefulSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_16","title":"Returns","text":"

StatefulSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getstatuses","title":"getStatuses","text":"

\u25b8 getStatuses(statefulSets): Object

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_13","title":"Parameters","text":"Name Type statefulSets StatefulSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_17","title":"Returns","text":"

Object

Name Type failed number pending number running number"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_18","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_14","title":"Parameters","text":"Name Type item StatefulSet"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_19","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_15","title":"Parameters","text":"Name Type visibleItems? StatefulSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_20","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#load","title":"load","text":"

\u25b8 load(params): Promise<StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_16","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_21","title":"Returns","text":"

Promise<StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | StatefulSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_17","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_22","title":"Returns","text":"

Promise<undefined | StatefulSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_18","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_23","title":"Returns","text":"

Promise<StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_19","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_24","title":"Returns","text":"

Promise<null | StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<StatefulSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_20","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_25","title":"Returns","text":"

Promise<StatefulSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): StatefulSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_21","title":"Parameters","text":"Name Type partialItems StatefulSet[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_26","title":"Returns","text":"

StatefulSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_22","title":"Parameters","text":"Name Type item StatefulSet patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_27","title":"Returns","text":"

Promise<StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): StatefulSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_23","title":"Parameters","text":"Name Type items StatefulSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_28","title":"Returns","text":"

StatefulSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | StatefulSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_24","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_29","title":"Returns","text":"

Promise<undefined | StatefulSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_25","title":"Parameters","text":"Name Type item StatefulSet"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_26","title":"Parameters","text":"Name Type item StatefulSet request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_27","title":"Parameters","text":"Name Type items StatefulSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_32","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_33","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_28","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_36","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_29","title":"Parameters","text":"Name Type item StatefulSet"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_37","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): StatefulSet[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_30","title":"Parameters","text":"Name Type Description items? StatefulSet[] the items to be sorted (default: the current items in this store) sorting? (item: StatefulSet) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_38","title":"Returns","text":"

StatefulSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_31","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_39","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_32","title":"Parameters","text":"Name Type item StatefulSet"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_33","title":"Parameters","text":"Name Type visibleItems? StatefulSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_41","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_34","title":"Parameters","text":"Name Type item StatefulSet"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_35","title":"Parameters","text":"Name Type item StatefulSet data PartialObjectDeep<StatefulSet, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_43","title":"Returns","text":"

Promise<StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_44","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_36","title":"Parameters","text":"Name Type item StatefulSet request () => Promise<StatefulSet>"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_45","title":"Returns","text":"

Promise<StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/","title":"Renderer.K8sApi.StorageClassStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / StorageClassStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#class-storageclassstore","title":"Class: StorageClassStore","text":"

Renderer.K8sApi.StorageClassStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<StorageClass, StorageClassApi, StorageClassData>

\u21b3 StorageClassStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getPersistentVolumes
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#constructor","title":"constructor","text":"

\u2022 new StorageClassStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters","title":"Parameters","text":"Name Type dependencies StorageClassStoreDependencies api StorageClassApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#overrides","title":"Overrides","text":"

KubeObjectStore<StorageClass, StorageClassApi, StorageClassData\\>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#api","title":"api","text":"

\u2022 Readonly api: StorageClassApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: StorageClass) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_1","title":"Parameters","text":"Name Type item StorageClass"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: StorageClassStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#overrides_1","title":"Overrides","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<StorageClassData>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#items","title":"items","text":"

\u2022 items: IObservableArray<StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<StorageClass, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_4","title":"Returns","text":"

Generator<StorageClass, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<StorageClass, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_6","title":"Returns","text":"

Promise<StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<StorageClass, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_7","title":"Returns","text":"

Promise<null | StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): StorageClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_5","title":"Parameters","text":"Name Type items StorageClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_8","title":"Returns","text":"

StorageClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): StorageClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_9","title":"Returns","text":"

StorageClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | StorageClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_10","title":"Returns","text":"

undefined | StorageClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): StorageClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_11","title":"Returns","text":"

StorageClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | StorageClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_12","title":"Returns","text":"

undefined | StorageClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | StorageClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_13","title":"Returns","text":"

undefined | StorageClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): StorageClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_15","title":"Returns","text":"

StorageClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getpersistentvolumes","title":"getPersistentVolumes","text":"

\u25b8 getPersistentVolumes(storageClass): PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_12","title":"Parameters","text":"Name Type storageClass StorageClass"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_16","title":"Returns","text":"

PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_17","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_13","title":"Parameters","text":"Name Type item StorageClass"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_14","title":"Parameters","text":"Name Type visibleItems? StorageClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_19","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#load","title":"load","text":"

\u25b8 load(params): Promise<StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_15","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_20","title":"Returns","text":"

Promise<StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | StorageClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_16","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_21","title":"Returns","text":"

Promise<undefined | StorageClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_17","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_22","title":"Returns","text":"

Promise<StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_18","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_23","title":"Returns","text":"

Promise<null | StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<StorageClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_19","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_24","title":"Returns","text":"

Promise<StorageClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): StorageClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_20","title":"Parameters","text":"Name Type partialItems StorageClass[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_25","title":"Returns","text":"

StorageClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_21","title":"Parameters","text":"Name Type item StorageClass patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_26","title":"Returns","text":"

Promise<StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): StorageClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_22","title":"Parameters","text":"Name Type items StorageClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_27","title":"Returns","text":"

StorageClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | StorageClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_23","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_28","title":"Returns","text":"

Promise<undefined | StorageClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_24","title":"Parameters","text":"Name Type item StorageClass"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_25","title":"Parameters","text":"Name Type item StorageClass request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_26","title":"Parameters","text":"Name Type items StorageClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_32","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_27","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_28","title":"Parameters","text":"Name Type item StorageClass"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_36","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): StorageClass[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_29","title":"Parameters","text":"Name Type Description items? StorageClass[] the items to be sorted (default: the current items in this store) sorting? (item: StorageClass) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_37","title":"Returns","text":"

StorageClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_30","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_38","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_31","title":"Parameters","text":"Name Type item StorageClass"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_32","title":"Parameters","text":"Name Type visibleItems? StorageClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_33","title":"Parameters","text":"Name Type item StorageClass"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_41","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_34","title":"Parameters","text":"Name Type item StorageClass data PartialObjectDeep<StorageClass, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_42","title":"Returns","text":"

Promise<StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_43","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_35","title":"Parameters","text":"Name Type item StorageClass request () => Promise<StorageClass>"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_44","title":"Returns","text":"

Promise<StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/","title":"Renderer.K8sApi.VerticalPodAutoscalerStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / VerticalPodAutoscalerStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#class-verticalpodautoscalerstore","title":"Class: VerticalPodAutoscalerStore","text":"

Renderer.K8sApi.VerticalPodAutoscalerStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<VerticalPodAutoscaler, VerticalPodAutoscalerApi>

\u21b3 VerticalPodAutoscalerStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#constructor","title":"constructor","text":"

\u2022 new VerticalPodAutoscalerStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api VerticalPodAutoscalerApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<VerticalPodAutoscaler, VerticalPodAutoscalerApi>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#api","title":"api","text":"

\u2022 Readonly api: VerticalPodAutoscalerApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: VerticalPodAutoscaler) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_1","title":"Parameters","text":"Name Type item VerticalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, VerticalPodAutoscalerStatus, VerticalPodAutoscalerSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#items","title":"items","text":"

\u2022 items: IObservableArray<VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<VerticalPodAutoscaler, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_4","title":"Returns","text":"

Generator<VerticalPodAutoscaler, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<VerticalPodAutoscaler, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_6","title":"Returns","text":"

Promise<VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<VerticalPodAutoscaler, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_7","title":"Returns","text":"

Promise<null | VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): VerticalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_5","title":"Parameters","text":"Name Type items VerticalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_8","title":"Returns","text":"

VerticalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): VerticalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_9","title":"Returns","text":"

VerticalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | VerticalPodAutoscaler

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_10","title":"Returns","text":"

undefined | VerticalPodAutoscaler

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): VerticalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_11","title":"Returns","text":"

VerticalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | VerticalPodAutoscaler

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_12","title":"Returns","text":"

undefined | VerticalPodAutoscaler

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | VerticalPodAutoscaler

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_13","title":"Returns","text":"

undefined | VerticalPodAutoscaler

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): VerticalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_15","title":"Returns","text":"

VerticalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_12","title":"Parameters","text":"Name Type item VerticalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? VerticalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#load","title":"load","text":"

\u25b8 load(params): Promise<VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_19","title":"Returns","text":"

Promise<VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | VerticalPodAutoscaler[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_20","title":"Returns","text":"

Promise<undefined | VerticalPodAutoscaler[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_21","title":"Returns","text":"

Promise<VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_22","title":"Returns","text":"

Promise<null | VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<VerticalPodAutoscaler[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_23","title":"Returns","text":"

Promise<VerticalPodAutoscaler[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): VerticalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_19","title":"Parameters","text":"Name Type partialItems VerticalPodAutoscaler[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_24","title":"Returns","text":"

VerticalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_20","title":"Parameters","text":"Name Type item VerticalPodAutoscaler patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_25","title":"Returns","text":"

Promise<VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): VerticalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_21","title":"Parameters","text":"Name Type items VerticalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_26","title":"Returns","text":"

VerticalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | VerticalPodAutoscaler[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_27","title":"Returns","text":"

Promise<undefined | VerticalPodAutoscaler[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_23","title":"Parameters","text":"Name Type item VerticalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_24","title":"Parameters","text":"Name Type item VerticalPodAutoscaler request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_25","title":"Parameters","text":"Name Type items VerticalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_27","title":"Parameters","text":"Name Type item VerticalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): VerticalPodAutoscaler[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_28","title":"Parameters","text":"Name Type Description items? VerticalPodAutoscaler[] the items to be sorted (default: the current items in this store) sorting? (item: VerticalPodAutoscaler) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_36","title":"Returns","text":"

VerticalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_30","title":"Parameters","text":"Name Type item VerticalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? VerticalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_32","title":"Parameters","text":"Name Type item VerticalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_33","title":"Parameters","text":"Name Type item VerticalPodAutoscaler data PartialObjectDeep<VerticalPodAutoscaler, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_41","title":"Returns","text":"

Promise<VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_34","title":"Parameters","text":"Name Type item VerticalPodAutoscaler request () => Promise<VerticalPodAutoscaler>"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_43","title":"Returns","text":"

Promise<VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/","title":"Renderer.K8sApi.VolumeClaimStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / VolumeClaimStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#class-volumeclaimstore","title":"Class: VolumeClaimStore","text":"

Renderer.K8sApi.VolumeClaimStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<PersistentVolumeClaim, PersistentVolumeClaimApi>

\u21b3 VolumeClaimStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#constructor","title":"constructor","text":"

\u2022 new VolumeClaimStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api PersistentVolumeClaimApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<PersistentVolumeClaim, PersistentVolumeClaimApi>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#api","title":"api","text":"

\u2022 Readonly api: PersistentVolumeClaimApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: PersistentVolumeClaim) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_1","title":"Parameters","text":"Name Type item PersistentVolumeClaim"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, PersistentVolumeClaimStatus, PersistentVolumeClaimSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#items","title":"items","text":"

\u2022 items: IObservableArray<PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<PersistentVolumeClaim, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_4","title":"Returns","text":"

Generator<PersistentVolumeClaim, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<PersistentVolumeClaim, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_6","title":"Returns","text":"

Promise<PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<PersistentVolumeClaim, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_7","title":"Returns","text":"

Promise<null | PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): PersistentVolumeClaim[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_5","title":"Parameters","text":"Name Type items PersistentVolumeClaim[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_8","title":"Returns","text":"

PersistentVolumeClaim[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): PersistentVolumeClaim[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_9","title":"Returns","text":"

PersistentVolumeClaim[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | PersistentVolumeClaim

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_10","title":"Returns","text":"

undefined | PersistentVolumeClaim

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): PersistentVolumeClaim[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_11","title":"Returns","text":"

PersistentVolumeClaim[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | PersistentVolumeClaim

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_12","title":"Returns","text":"

undefined | PersistentVolumeClaim

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | PersistentVolumeClaim

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_13","title":"Returns","text":"

undefined | PersistentVolumeClaim

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): PersistentVolumeClaim[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_15","title":"Returns","text":"

PersistentVolumeClaim[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_12","title":"Parameters","text":"Name Type item PersistentVolumeClaim"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? PersistentVolumeClaim[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#load","title":"load","text":"

\u25b8 load(params): Promise<PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_19","title":"Returns","text":"

Promise<PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | PersistentVolumeClaim[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_20","title":"Returns","text":"

Promise<undefined | PersistentVolumeClaim[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_21","title":"Returns","text":"

Promise<PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_22","title":"Returns","text":"

Promise<null | PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<PersistentVolumeClaim[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_23","title":"Returns","text":"

Promise<PersistentVolumeClaim[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): PersistentVolumeClaim[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_19","title":"Parameters","text":"Name Type partialItems PersistentVolumeClaim[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_24","title":"Returns","text":"

PersistentVolumeClaim[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_20","title":"Parameters","text":"Name Type item PersistentVolumeClaim patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_25","title":"Returns","text":"

Promise<PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): PersistentVolumeClaim[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_21","title":"Parameters","text":"Name Type items PersistentVolumeClaim[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_26","title":"Returns","text":"

PersistentVolumeClaim[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | PersistentVolumeClaim[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_27","title":"Returns","text":"

Promise<undefined | PersistentVolumeClaim[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_23","title":"Parameters","text":"Name Type item PersistentVolumeClaim"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_24","title":"Parameters","text":"Name Type item PersistentVolumeClaim request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_25","title":"Parameters","text":"Name Type items PersistentVolumeClaim[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_27","title":"Parameters","text":"Name Type item PersistentVolumeClaim"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): PersistentVolumeClaim[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_28","title":"Parameters","text":"Name Type Description items? PersistentVolumeClaim[] the items to be sorted (default: the current items in this store) sorting? (item: PersistentVolumeClaim) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_36","title":"Returns","text":"

PersistentVolumeClaim[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_30","title":"Parameters","text":"Name Type item PersistentVolumeClaim"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? PersistentVolumeClaim[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_32","title":"Parameters","text":"Name Type item PersistentVolumeClaim"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_33","title":"Parameters","text":"Name Type item PersistentVolumeClaim data PartialObjectDeep<PersistentVolumeClaim, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_41","title":"Returns","text":"

Promise<PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_34","title":"Parameters","text":"Name Type item PersistentVolumeClaim request () => Promise<PersistentVolumeClaim>"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_43","title":"Returns","text":"

Promise<PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.LensExtension/","title":"Renderer.LensExtension","text":"

@k8slens/extensions / Exports / Renderer / LensExtension

"},{"location":"extensions/api/classes/Renderer.LensExtension/#class-lensextension","title":"Class: LensExtension","text":"

Renderer.LensExtension

"},{"location":"extensions/api/classes/Renderer.LensExtension/#hierarchy","title":"Hierarchy","text":"
  • LensExtension

\u21b3 LensExtension

"},{"location":"extensions/api/classes/Renderer.LensExtension/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.LensExtension/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.LensExtension/#properties","title":"Properties","text":"
  • additionalCategoryColumns
  • appPreferenceTabs
  • appPreferences
  • catalogEntityDetailItems
  • clusterFrameComponents
  • clusterPageMenus
  • clusterPages
  • commands
  • customCategoryViews
  • entitySettings
  • globalPages
  • id
  • isBundled
  • kubeObjectDetailItems
  • kubeObjectHandlers
  • kubeObjectMenuItems
  • kubeObjectStatusTexts
  • kubeWorkloadsOverviewItems
  • manifest
  • manifestPath
  • protocolHandlers
  • statusBarItems
  • topBarItems
  • welcomeBanners
  • welcomeMenus
"},{"location":"extensions/api/classes/Renderer.LensExtension/#accessors","title":"Accessors","text":"
  • description
  • isEnabled
  • name
  • sanitizedExtensionId
  • storeName
  • version
"},{"location":"extensions/api/classes/Renderer.LensExtension/#methods","title":"Methods","text":"
  • activate
  • addCatalogCategoryFilter
  • addCatalogFilter
  • disable
  • enable
  • getExtensionFileFolder
  • isEnabledForCluster
  • navigate
  • onActivate
  • onDeactivate
"},{"location":"extensions/api/classes/Renderer.LensExtension/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.LensExtension/#constructor","title":"constructor","text":"

\u2022 new LensExtension(extension)

"},{"location":"extensions/api/classes/Renderer.LensExtension/#parameters","title":"Parameters","text":"Name Type extension InstalledExtension"},{"location":"extensions/api/classes/Renderer.LensExtension/#overrides","title":"Overrides","text":"

LensExtension.constructor

"},{"location":"extensions/api/classes/Renderer.LensExtension/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.LensExtension/#additionalcategorycolumns","title":"additionalCategoryColumns","text":"

\u2022 additionalCategoryColumns: AdditionalCategoryColumnRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#apppreferencetabs","title":"appPreferenceTabs","text":"

\u2022 appPreferenceTabs: AppPreferenceTabRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#apppreferences","title":"appPreferences","text":"

\u2022 appPreferences: AppPreferenceRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#catalogentitydetailitems","title":"catalogEntityDetailItems","text":"

\u2022 catalogEntityDetailItems: CatalogEntityDetailRegistration<CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>>[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#clusterframecomponents","title":"clusterFrameComponents","text":"

\u2022 clusterFrameComponents: ClusterFrameChildComponent[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#clusterpagemenus","title":"clusterPageMenus","text":"

\u2022 clusterPageMenus: ClusterPageMenuRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#clusterpages","title":"clusterPages","text":"

\u2022 clusterPages: PageRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#commands","title":"commands","text":"

\u2022 commands: CommandRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#customcategoryviews","title":"customCategoryViews","text":"

\u2022 customCategoryViews: CustomCategoryViewRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#entitysettings","title":"entitySettings","text":"

\u2022 entitySettings: EntitySettingRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#globalpages","title":"globalPages","text":"

\u2022 globalPages: PageRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#id","title":"id","text":"

\u2022 Readonly id: string

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from","title":"Inherited from","text":"

LensExtension.id

"},{"location":"extensions/api/classes/Renderer.LensExtension/#isbundled","title":"isBundled","text":"

\u2022 Readonly isBundled: boolean

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_1","title":"Inherited from","text":"

LensExtension.isBundled

"},{"location":"extensions/api/classes/Renderer.LensExtension/#kubeobjectdetailitems","title":"kubeObjectDetailItems","text":"

\u2022 kubeObjectDetailItems: KubeObjectDetailRegistration<KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>>[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#kubeobjecthandlers","title":"kubeObjectHandlers","text":"

\u2022 kubeObjectHandlers: KubeObjectHandlerRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#kubeobjectmenuitems","title":"kubeObjectMenuItems","text":"

\u2022 kubeObjectMenuItems: KubeObjectMenuRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#kubeobjectstatustexts","title":"kubeObjectStatusTexts","text":"

\u2022 kubeObjectStatusTexts: KubeObjectStatusRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#kubeworkloadsoverviewitems","title":"kubeWorkloadsOverviewItems","text":"

\u2022 kubeWorkloadsOverviewItems: WorkloadsOverviewDetailRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#manifest","title":"manifest","text":"

\u2022 Readonly manifest: LensExtensionManifest

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_2","title":"Inherited from","text":"

LensExtension.manifest

"},{"location":"extensions/api/classes/Renderer.LensExtension/#manifestpath","title":"manifestPath","text":"

\u2022 Readonly manifestPath: string

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_3","title":"Inherited from","text":"

LensExtension.manifestPath

"},{"location":"extensions/api/classes/Renderer.LensExtension/#protocolhandlers","title":"protocolHandlers","text":"

\u2022 protocolHandlers: ProtocolHandlerRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_4","title":"Inherited from","text":"

LensExtension.protocolHandlers

"},{"location":"extensions/api/classes/Renderer.LensExtension/#statusbaritems","title":"statusBarItems","text":"

\u2022 statusBarItems: StatusBarRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#topbaritems","title":"topBarItems","text":"

\u2022 topBarItems: TopBarRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#welcomebanners","title":"welcomeBanners","text":"

\u2022 welcomeBanners: WelcomeBannerRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#welcomemenus","title":"welcomeMenus","text":"

\u2022 welcomeMenus: WelcomeMenuRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.LensExtension/#description","title":"description","text":"

\u2022 get description(): undefined | string

"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns","title":"Returns","text":"

undefined | string

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_5","title":"Inherited from","text":"

LensExtension.description

"},{"location":"extensions/api/classes/Renderer.LensExtension/#isenabled","title":"isEnabled","text":"

\u2022 get isEnabled(): boolean

"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_1","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_6","title":"Inherited from","text":"

LensExtension.isEnabled

"},{"location":"extensions/api/classes/Renderer.LensExtension/#name","title":"name","text":"

\u2022 get name(): string

"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_2","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_7","title":"Inherited from","text":"

LensExtension.name

"},{"location":"extensions/api/classes/Renderer.LensExtension/#sanitizedextensionid","title":"sanitizedExtensionId","text":"

\u2022 get sanitizedExtensionId(): string

"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_3","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_8","title":"Inherited from","text":"

LensExtension.sanitizedExtensionId

"},{"location":"extensions/api/classes/Renderer.LensExtension/#storename","title":"storeName","text":"

\u2022 get storeName(): string

"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_4","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_9","title":"Inherited from","text":"

LensExtension.storeName

"},{"location":"extensions/api/classes/Renderer.LensExtension/#version","title":"version","text":"

\u2022 get version(): string

"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_5","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_10","title":"Inherited from","text":"

LensExtension.version

"},{"location":"extensions/api/classes/Renderer.LensExtension/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.LensExtension/#activate","title":"activate","text":"

\u25b8 activate(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_6","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_11","title":"Inherited from","text":"

LensExtension.activate

"},{"location":"extensions/api/classes/Renderer.LensExtension/#addcatalogcategoryfilter","title":"addCatalogCategoryFilter","text":"

\u25b8 addCatalogCategoryFilter(fn): Disposer

Add a filtering function for the catalog categories. This will be removed if the extension is disabled.

"},{"location":"extensions/api/classes/Renderer.LensExtension/#parameters_1","title":"Parameters","text":"Name Type Description fn CategoryFilter The function which should return a truthy value for those categories which should be kept."},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_7","title":"Returns","text":"

Disposer

A function to clean up the filter

"},{"location":"extensions/api/classes/Renderer.LensExtension/#addcatalogfilter","title":"addCatalogFilter","text":"

\u25b8 addCatalogFilter(fn): Disposer

Add a filtering function for the catalog entities. This will be removed if the extension is disabled.

"},{"location":"extensions/api/classes/Renderer.LensExtension/#parameters_2","title":"Parameters","text":"Name Type Description fn EntityFilter The function which should return a truthy value for those entities which should be kept."},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_8","title":"Returns","text":"

Disposer

A function to clean up the filter

"},{"location":"extensions/api/classes/Renderer.LensExtension/#disable","title":"disable","text":"

\u25b8 disable(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_9","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_12","title":"Inherited from","text":"

LensExtension.disable

"},{"location":"extensions/api/classes/Renderer.LensExtension/#enable","title":"enable","text":"

\u25b8 enable(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_10","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_13","title":"Inherited from","text":"

LensExtension.enable

"},{"location":"extensions/api/classes/Renderer.LensExtension/#getextensionfilefolder","title":"getExtensionFileFolder","text":"

\u25b8 getExtensionFileFolder(): Promise<string>

getExtensionFileFolder returns the path to an already created folder. This folder is for the sole use of this extension.

Note: there is no security done on this folder, only obfuscation of the folder name.

"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_11","title":"Returns","text":"

Promise<string>

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_14","title":"Inherited from","text":"

LensExtension.getExtensionFileFolder

"},{"location":"extensions/api/classes/Renderer.LensExtension/#isenabledforcluster","title":"isEnabledForCluster","text":"

\u25b8 isEnabledForCluster(cluster): Promise<Boolean>

Defines if extension is enabled for a given cluster. This method is only called when the extension is created within a cluster frame.

The default implementation is to return true

Deprecated

Switch to using \"enabled\" or \"visible\" properties in each registration together with activeCluster

"},{"location":"extensions/api/classes/Renderer.LensExtension/#parameters_3","title":"Parameters","text":"Name Type cluster KubernetesCluster<KubernetesClusterMetadata, KubernetesClusterStatus, KubernetesClusterSpec>"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_12","title":"Returns","text":"

Promise<Boolean>

"},{"location":"extensions/api/classes/Renderer.LensExtension/#navigate","title":"navigate","text":"

\u25b8 navigate(pageId?, params?): Promise<void>

"},{"location":"extensions/api/classes/Renderer.LensExtension/#parameters_4","title":"Parameters","text":"Name Type pageId? string params? object"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_13","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.LensExtension/#onactivate","title":"onActivate","text":"

\u25b8 Protected onActivate(): void | Promise<void>

"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_14","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_15","title":"Inherited from","text":"

LensExtension.onActivate

"},{"location":"extensions/api/classes/Renderer.LensExtension/#ondeactivate","title":"onDeactivate","text":"

\u25b8 Protected onDeactivate(): void | Promise<void>

"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_15","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_16","title":"Inherited from","text":"

LensExtension.onDeactivate

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/","title":"Renderer.Navigation.PageParam","text":"

@k8slens/extensions / Exports / Renderer / Navigation / PageParam

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#class-pageparamvalue","title":"Class: PageParam<Value>","text":"

Renderer.Navigation.PageParam

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#type-parameters","title":"Type parameters","text":"Name Type Value any"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#properties","title":"Properties","text":"
  • dependencies
  • isMulti
  • name
"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#accessors","title":"Accessors","text":"
  • defaultValue
"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#methods","title":"Methods","text":"
  • clear
  • get
  • getRaw
  • parse
  • set
  • setRaw
  • stringify
  • toString
"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#constructor","title":"constructor","text":"

\u2022 new PageParam<Value>(dependencies, init)

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#type-parameters_1","title":"Type parameters","text":"Name Type Value any"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#parameters","title":"Parameters","text":"Name Type dependencies PageParamDependencies init PageParamInit<Value>"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: PageParamDependencies

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#ismulti","title":"isMulti","text":"

\u2022 Readonly isMulti: boolean

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#name","title":"name","text":"

\u2022 Readonly name: string

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#defaultvalue","title":"defaultValue","text":"

\u2022 get defaultValue(): undefined | Value

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#returns","title":"Returns","text":"

undefined | Value

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#clear","title":"clear","text":"

\u25b8 clear(): void

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#get","title":"get","text":"

\u25b8 get(): Value

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#returns_2","title":"Returns","text":"

Value

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#getraw","title":"getRaw","text":"

\u25b8 getRaw(): string | string[]

Get stringified raw value(s) from document.location.search

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#returns_3","title":"Returns","text":"

string | string[]

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#parse","title":"parse","text":"

\u25b8 parse(values): Value

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#parameters_1","title":"Parameters","text":"Name Type values string | string[]"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#returns_4","title":"Returns","text":"

Value

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#set","title":"set","text":"

\u25b8 set(value, \u00abdestructured\u00bb?): void

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#parameters_2","title":"Parameters","text":"Name Type value Value \u00abdestructured\u00bb Object \u203a\u00a0mergeGlobals? boolean \u203a\u00a0replaceHistory? boolean"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#setraw","title":"setRaw","text":"

\u25b8 setRaw(value): void

Set stringified raw value(s) and update document.location.search

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#parameters_3","title":"Parameters","text":"Name Type value string | string[]"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#returns_6","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#stringify","title":"stringify","text":"

\u25b8 stringify(value?): string[]

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#parameters_4","title":"Parameters","text":"Name Type value? Value"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#returns_7","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#tostring","title":"toString","text":"

\u25b8 toString(\u00abdestructured\u00bb?): string

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#parameters_5","title":"Parameters","text":"Name Type \u00abdestructured\u00bb Object \u203a\u00a0mergeGlobals? boolean \u203a\u00a0value? Value"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#returns_8","title":"Returns","text":"

string

"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/","title":"Renderer.Component.NotificationStatus","text":"

@k8slens/extensions / Exports / Renderer / Component / NotificationStatus

"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#enumeration-notificationstatus","title":"Enumeration: NotificationStatus","text":"

Renderer.Component.NotificationStatus

"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#enumeration-members","title":"Enumeration Members","text":"
  • ERROR
  • INFO
  • OK
"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#enumeration-members_1","title":"Enumeration Members","text":""},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#error","title":"ERROR","text":"

\u2022 ERROR = \"error\"

"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#info","title":"INFO","text":"

\u2022 INFO = \"info\"

"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#ok","title":"OK","text":"

\u2022 OK = \"ok\"

"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/","title":"Renderer.Component.TooltipPosition","text":"

@k8slens/extensions / Exports / Renderer / Component / TooltipPosition

"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#enumeration-tooltipposition","title":"Enumeration: TooltipPosition","text":"

Renderer.Component.TooltipPosition

"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#enumeration-members","title":"Enumeration Members","text":"
  • BOTTOM
  • BOTTOM_LEFT
  • BOTTOM_RIGHT
  • LEFT
  • RIGHT
  • TOP
  • TOP_LEFT
  • TOP_RIGHT
"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#enumeration-members_1","title":"Enumeration Members","text":""},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#bottom","title":"BOTTOM","text":"

\u2022 BOTTOM = \"bottom\"

"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#bottom_left","title":"BOTTOM_LEFT","text":"

\u2022 BOTTOM_LEFT = \"bottom_left\"

"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#bottom_right","title":"BOTTOM_RIGHT","text":"

\u2022 BOTTOM_RIGHT = \"bottom_right\"

"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#left","title":"LEFT","text":"

\u2022 LEFT = \"left\"

"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#right","title":"RIGHT","text":"

\u2022 RIGHT = \"right\"

"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#top","title":"TOP","text":"

\u2022 TOP = \"top\"

"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#top_left","title":"TOP_LEFT","text":"

\u2022 TOP_LEFT = \"top_left\"

"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#top_right","title":"TOP_RIGHT","text":"

\u2022 TOP_RIGHT = \"top_right\"

"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/","title":"Renderer.K8sApi.KubeObjectStatusLevel","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / KubeObjectStatusLevel

"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#enumeration-kubeobjectstatuslevel","title":"Enumeration: KubeObjectStatusLevel","text":"

Renderer.K8sApi.KubeObjectStatusLevel

"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#enumeration-members","title":"Enumeration Members","text":"
  • CRITICAL
  • INFO
  • WARNING
"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#enumeration-members_1","title":"Enumeration Members","text":""},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#critical","title":"CRITICAL","text":"

\u2022 CRITICAL = 3

"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#info","title":"INFO","text":"

\u2022 INFO = 1

"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#warning","title":"WARNING","text":"

\u2022 WARNING = 2

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/","title":"Common.Catalog.CatalogCategoryEvents","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogCategoryEvents

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#interface-catalogcategoryevents","title":"Interface: CatalogCategoryEvents","text":"

Common.Catalog.CatalogCategoryEvents

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#properties","title":"Properties","text":"
  • catalogAddMenu
  • contextMenuOpen
  • load
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#catalogaddmenu","title":"catalogAddMenu","text":"

\u2022 catalogAddMenu: (context: CatalogEntityAddMenuContext) => void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#type-declaration","title":"Type declaration","text":"

\u25b8 (context): void

This event will be emitted when the catalog add menu is opened and is the way to added entries to that menu.

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#parameters","title":"Parameters","text":"Name Type context CatalogEntityAddMenuContext"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#contextmenuopen","title":"contextMenuOpen","text":"

\u2022 contextMenuOpen: (entity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>, context: CatalogEntityContextMenuContext) => void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (entity, context): void

This event will be emitted when the context menu for an entity is declared by this category is opened.

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#parameters_1","title":"Parameters","text":"Name Type entity CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec> context CatalogEntityContextMenuContext"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#load","title":"load","text":"

\u2022 load: () => void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (): void

This event will be emitted when the category is loaded in the catalog view.

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/","title":"Common.Catalog.CatalogCategoryMetadata","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogCategoryMetadata

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/#interface-catalogcategorymetadata","title":"Interface: CatalogCategoryMetadata","text":"

Common.Catalog.CatalogCategoryMetadata

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/#properties","title":"Properties","text":"
  • icon
  • name
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/#icon","title":"icon","text":"

\u2022 Readonly icon: string

Either an <svg> or one of the provided svg names from NamedSvg

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/#name","title":"name","text":"

\u2022 Readonly name: string

The name of your category. The category can be searched for by this value. This will also be used for the catalog menu.

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/","title":"Common.Catalog.CatalogCategorySpec","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogCategorySpec

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#interface-catalogcategoryspec","title":"Interface: CatalogCategorySpec","text":"

Common.Catalog.CatalogCategorySpec

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#properties","title":"Properties","text":"
  • displayColumns
  • group
  • names
  • versions
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#displaycolumns","title":"displayColumns","text":"

\u2022 Optional Readonly displayColumns: CategoryColumnRegistration[]

These are the columns used for displaying entities when in the catalog.

If this is not provided then some default columns will be used, similar in scope to the columns in the \"Browse\" view.

Even if you provide columns, a \"Name\" column will be provided as well with priority: 0.

These columns will not be used in the \"Browse\" view.

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#group","title":"group","text":"

\u2022 Readonly group: string

The grouping for for the category. This MUST be a DNS label.

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#names","title":"names","text":"

\u2022 Readonly names: Object

This is the concerning the category

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#type-declaration","title":"Type declaration","text":"Name Type Description kind string The kind of entity that this category is for. This value MUST be a DNS label and MUST be equal to the kind fields that are produced by the .versions.[] \\| .entityClass fields."},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#versions","title":"versions","text":"

\u2022 Readonly versions: CatalogCategoryVersion[]

The specific versions of the constructors.

NOTE: the field .apiVersion after construction MUST match {.group}/{.versions.[] | .name}. For example, if group = \"entity.k8slens.dev\" and there is an entry in .versions with name = \"v1alpha1\" then the resulting .apiVersion MUST be entity.k8slens.dev/v1alpha1

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/","title":"Common.Catalog.CatalogCategoryVersion","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogCategoryVersion

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/#interface-catalogcategoryversion","title":"Interface: CatalogCategoryVersion","text":"

Common.Catalog.CatalogCategoryVersion

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/#properties","title":"Properties","text":"
  • entityClass
  • name
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/#entityclass","title":"entityClass","text":"

\u2022 Readonly entityClass: CatalogEntityConstructor<CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>>

The constructor for the entities.

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/#name","title":"name","text":"

\u2022 Readonly name: string

The specific version that the associated constructor is for. This MUST be a DNS label and SHOULD be of the form vN, vNalphaY, or vNbetaY where N and Y are both integers greater than 0.

Examples: The following are valid values for this field. - v1 - v1beta1 - v1alpha2 - v3beta2

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/","title":"Common.Catalog.CatalogEntityActionContext","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogEntityActionContext

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#interface-catalogentityactioncontext","title":"Interface: CatalogEntityActionContext","text":"

Common.Catalog.CatalogEntityActionContext

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#properties","title":"Properties","text":"
  • navigate
  • setCommandPaletteContext
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#navigate","title":"navigate","text":"

\u2022 navigate: (url: string) => void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#type-declaration","title":"Type declaration","text":"

\u25b8 (url): void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#parameters","title":"Parameters","text":"Name Type url string"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#setcommandpalettecontext","title":"setCommandPaletteContext","text":"

\u2022 setCommandPaletteContext: (context?: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>) => void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (context?): void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#parameters_1","title":"Parameters","text":"Name Type context? CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/","title":"Common.Catalog.CatalogEntityAddMenu","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogEntityAddMenu

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#interface-catalogentityaddmenu","title":"Interface: CatalogEntityAddMenu","text":"

Common.Catalog.CatalogEntityAddMenu

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#hierarchy","title":"Hierarchy","text":"
  • CatalogEntityContextMenu

\u21b3 CatalogEntityAddMenu

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#properties","title":"Properties","text":"
  • confirm
  • defaultAction
  • icon
  • onClick
  • title
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#confirm","title":"confirm","text":"

\u2022 Optional confirm: Object

Confirm click with a message

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#type-declaration","title":"Type declaration","text":"Name Type message string"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#inherited-from","title":"Inherited from","text":"

CatalogEntityContextMenu.confirm

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#defaultaction","title":"defaultAction","text":"

\u2022 Optional defaultAction: boolean

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#icon","title":"icon","text":"

\u2022 icon: string

Menu icon

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#overrides","title":"Overrides","text":"

CatalogEntityContextMenu.icon

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#onclick","title":"onClick","text":"

\u2022 onClick: () => void | Promise<void>

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (): void | Promise<void>

OnClick handler

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#returns","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#inherited-from_1","title":"Inherited from","text":"

CatalogEntityContextMenu.onClick

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#title","title":"title","text":"

\u2022 title: string

Menu title

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#inherited-from_2","title":"Inherited from","text":"

CatalogEntityContextMenu.title

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/","title":"Common.Catalog.CatalogEntityAddMenuContext","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogEntityAddMenuContext

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#interface-catalogentityaddmenucontext","title":"Interface: CatalogEntityAddMenuContext","text":"

Common.Catalog.CatalogEntityAddMenuContext

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#properties","title":"Properties","text":"
  • menuItems
  • navigate
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#menuitems","title":"menuItems","text":"

\u2022 menuItems: CatalogEntityAddMenu[]

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#navigate","title":"navigate","text":"

\u2022 navigate: (url: string) => void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#type-declaration","title":"Type declaration","text":"

\u25b8 (url): void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#parameters","title":"Parameters","text":"Name Type url string"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/","title":"Common.Catalog.CatalogEntityContextMenu","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogEntityContextMenu

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#interface-catalogentitycontextmenu","title":"Interface: CatalogEntityContextMenu","text":"

Common.Catalog.CatalogEntityContextMenu

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#hierarchy","title":"Hierarchy","text":"
  • CatalogEntityContextMenu

\u21b3 CatalogEntityAddMenu

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#properties","title":"Properties","text":"
  • confirm
  • icon
  • onClick
  • title
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#confirm","title":"confirm","text":"

\u2022 Optional confirm: Object

Confirm click with a message

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#type-declaration","title":"Type declaration","text":"Name Type message string"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#icon","title":"icon","text":"

\u2022 Optional icon: string

Menu icon

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#onclick","title":"onClick","text":"

\u2022 onClick: () => void | Promise<void>

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (): void | Promise<void>

OnClick handler

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#returns","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#title","title":"title","text":"

\u2022 title: string

Menu title

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/","title":"Common.Catalog.CatalogEntityContextMenuContext","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogEntityContextMenuContext

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/#interface-catalogentitycontextmenucontext","title":"Interface: CatalogEntityContextMenuContext","text":"

Common.Catalog.CatalogEntityContextMenuContext

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/#properties","title":"Properties","text":"
  • menuItems
  • navigate
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/#menuitems","title":"menuItems","text":"

\u2022 menuItems: CatalogEntityContextMenu[]

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/#navigate","title":"navigate","text":"

\u2022 navigate: CatalogEntityContextMenuNavigate

Navigate to the specified pathname

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/","title":"Common.Catalog.CatalogEntityContextMenuNavigate","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogEntityContextMenuNavigate

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/#interface-catalogentitycontextmenunavigate","title":"Interface: CatalogEntityContextMenuNavigate","text":"

Common.Catalog.CatalogEntityContextMenuNavigate

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/#callable","title":"Callable","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/#catalogentitycontextmenunavigate","title":"CatalogEntityContextMenuNavigate","text":"

\u25b8 CatalogEntityContextMenuNavigate(pathname, forceMainFrame?): void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/#parameters","title":"Parameters","text":"Name Type Description pathname string The location to navigate to in the main iframe forceMainFrame? boolean -"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/#catalogentitycontextmenunavigate_1","title":"CatalogEntityContextMenuNavigate","text":"

\u25b8 CatalogEntityContextMenuNavigate(pathname, forceMainFrame): void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/#parameters_1","title":"Parameters","text":"Name Type Description pathname string The location to navigate to in the current iframe. Useful for when called within the cluster frame forceMainFrame false -"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/","title":"Common.Catalog.CatalogEntityData","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogEntityData

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#interface-catalogentitydatametadata-status-spec","title":"Interface: CatalogEntityData<Metadata, Status, Spec>","text":"

Common.Catalog.CatalogEntityData

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends CatalogEntityMetadata = CatalogEntityMetadata Status extends CatalogEntityStatus = CatalogEntityStatus Spec extends CatalogEntitySpec = CatalogEntitySpec"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#properties","title":"Properties","text":"
  • metadata
  • spec
  • status
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#metadata","title":"metadata","text":"

\u2022 metadata: Metadata

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#spec","title":"spec","text":"

\u2022 spec: Spec

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#status","title":"status","text":"

\u2022 status: Status

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/","title":"Common.Catalog.CatalogEntityKindData","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogEntityKindData

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#interface-catalogentitykinddata","title":"Interface: CatalogEntityKindData","text":"

Common.Catalog.CatalogEntityKindData

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#implemented-by","title":"Implemented by","text":"
  • CatalogEntity
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#properties","title":"Properties","text":"
  • apiVersion
  • kind
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#apiversion","title":"apiVersion","text":"

\u2022 Readonly apiVersion: string

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#kind","title":"kind","text":"

\u2022 Readonly kind: string

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/","title":"Common.Catalog.CatalogEntityMetadata","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogEntityMetadata

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#interface-catalogentitymetadata","title":"Interface: CatalogEntityMetadata","text":"

Common.Catalog.CatalogEntityMetadata

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#hierarchy","title":"Hierarchy","text":"
  • EntityMetadataObject

\u21b3 CatalogEntityMetadata

\u21b3\u21b3 KubernetesClusterMetadata

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#properties","title":"Properties","text":"
  • description
  • labels
  • name
  • shortName
  • source
  • uid
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#description","title":"description","text":"

\u2022 Optional description: string

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#labels","title":"labels","text":"

\u2022 labels: Partial<Record<string, string>>

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#name","title":"name","text":"

\u2022 name: string

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#shortname","title":"shortName","text":"

\u2022 Optional shortName: string

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#source","title":"source","text":"

\u2022 Optional source: string

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#uid","title":"uid","text":"

\u2022 uid: string

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/","title":"Common.Catalog.CatalogEntitySettingsContext","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogEntitySettingsContext

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/#interface-catalogentitysettingscontext","title":"Interface: CatalogEntitySettingsContext","text":"

Common.Catalog.CatalogEntitySettingsContext

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/#properties","title":"Properties","text":"
  • menuItems
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/#menuitems","title":"menuItems","text":"

\u2022 menuItems: CatalogEntityContextMenu[]

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/","title":"Common.Catalog.CatalogEntitySettingsMenu","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogEntitySettingsMenu

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#interface-catalogentitysettingsmenu","title":"Interface: CatalogEntitySettingsMenu","text":"

Common.Catalog.CatalogEntitySettingsMenu

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#properties","title":"Properties","text":"
  • components
  • group
  • title
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#components","title":"components","text":"

\u2022 components: Object

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#type-declaration","title":"Type declaration","text":"Name Type View ComponentType<any>"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#group","title":"group","text":"

\u2022 Optional group: string

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#title","title":"title","text":"

\u2022 title: string

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/","title":"Common.Catalog.CatalogEntityStatus","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogEntityStatus

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#interface-catalogentitystatus","title":"Interface: CatalogEntityStatus","text":"

Common.Catalog.CatalogEntityStatus

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#hierarchy","title":"Hierarchy","text":"
  • CatalogEntityStatus

\u21b3 WebLinkStatus

\u21b3 KubernetesClusterStatus

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#properties","title":"Properties","text":"
  • active
  • enabled
  • message
  • phase
  • reason
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#active","title":"active","text":"

\u2022 Optional active: boolean

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#enabled","title":"enabled","text":"

\u2022 Optional enabled: boolean

Default

true\n
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#message","title":"message","text":"

\u2022 Optional message: string

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#phase","title":"phase","text":"

\u2022 phase: string

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#reason","title":"reason","text":"

\u2022 Optional reason: string

"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/","title":"Common.Catalog.CategoryColumnRegistration","text":"

@k8slens/extensions / Exports / Common / Catalog / CategoryColumnRegistration

"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#interface-categorycolumnregistration","title":"Interface: CategoryColumnRegistration","text":"

Common.Catalog.CategoryColumnRegistration

"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#hierarchy","title":"Hierarchy","text":"
  • CategoryColumnRegistration

\u21b3 AdditionalCategoryColumnRegistration

"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#properties","title":"Properties","text":"
  • id
  • priority
  • renderCell
  • searchFilter
  • sortCallback
  • titleProps
"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#id","title":"id","text":"

\u2022 id: string

This value MUST to be unique to your extension

"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#priority","title":"priority","text":"

\u2022 Optional priority: number

The sorting order value.

Default

50\n
"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#rendercell","title":"renderCell","text":"

\u2022 renderCell: (entity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>) => ReactNode

"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#type-declaration","title":"Type declaration","text":"

\u25b8 (entity): ReactNode

This function will be called to generate the cells (on demand) for the column

"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#parameters","title":"Parameters","text":"Name Type entity CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#returns","title":"Returns","text":"

ReactNode

"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#searchfilter","title":"searchFilter","text":"

\u2022 Optional searchFilter: (entity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>) => string | string[]

"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (entity): string | string[]

If provided then searching is supported on this column and this function will be called to determine if the current search string matches for this row.

"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#parameters_1","title":"Parameters","text":"Name Type entity CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#returns_1","title":"Returns","text":"

string | string[]

"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#sortcallback","title":"sortCallback","text":"

\u2022 Optional sortCallback: (entity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>) => string | number | (string | number)[]

"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (entity): string | number | (string | number)[]

If provided then the column will support sorting and this function will be called to determine a row's ordering.

strings are sorted ahead of numbers, and arrays determine ordering between equal elements of the previous index.

"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#parameters_2","title":"Parameters","text":"Name Type entity CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#returns_2","title":"Returns","text":"

string | number | (string | number)[]

"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#titleprops","title":"titleProps","text":"

\u2022 titleProps: TitleCellProps

This function will be used to generate the columns title cell.

"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/","title":"Common.Catalog.GeneralEntitySpec","text":"

@k8slens/extensions / Exports / Common / Catalog / GeneralEntitySpec

"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#interface-generalentityspec","title":"Interface: GeneralEntitySpec","text":"

Common.Catalog.GeneralEntitySpec

"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#hierarchy","title":"Hierarchy","text":"
  • CatalogEntitySpec

\u21b3 GeneralEntitySpec

"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#properties","title":"Properties","text":"
  • icon
  • path
"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#icon","title":"icon","text":"

\u2022 Optional icon: Object

"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#type-declaration","title":"Type declaration","text":"Name Type background? string material? string"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#path","title":"path","text":"

\u2022 path: string

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/","title":"Common.Catalog.KubernetesClusterMetadata","text":"

@k8slens/extensions / Exports / Common / Catalog / KubernetesClusterMetadata

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#interface-kubernetesclustermetadata","title":"Interface: KubernetesClusterMetadata","text":"

Common.Catalog.KubernetesClusterMetadata

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#hierarchy","title":"Hierarchy","text":"
  • CatalogEntityMetadata

\u21b3 KubernetesClusterMetadata

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#properties","title":"Properties","text":"
  • description
  • distro
  • kubeVersion
  • labels
  • name
  • shortName
  • source
  • uid
"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#description","title":"description","text":"

\u2022 Optional description: string

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#inherited-from","title":"Inherited from","text":"

CatalogEntityMetadata.description

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#distro","title":"distro","text":"

\u2022 Optional distro: string

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#kubeversion","title":"kubeVersion","text":"

\u2022 Optional kubeVersion: string

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#labels","title":"labels","text":"

\u2022 labels: Partial<Record<string, string>>

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#inherited-from_1","title":"Inherited from","text":"

CatalogEntityMetadata.labels

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#name","title":"name","text":"

\u2022 name: string

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#inherited-from_2","title":"Inherited from","text":"

CatalogEntityMetadata.name

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#shortname","title":"shortName","text":"

\u2022 Optional shortName: string

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#inherited-from_3","title":"Inherited from","text":"

CatalogEntityMetadata.shortName

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#source","title":"source","text":"

\u2022 Optional source: string

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#inherited-from_4","title":"Inherited from","text":"

CatalogEntityMetadata.source

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#uid","title":"uid","text":"

\u2022 uid: string

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#inherited-from_5","title":"Inherited from","text":"

CatalogEntityMetadata.uid

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/","title":"Common.Catalog.KubernetesClusterPrometheusMetrics","text":"

@k8slens/extensions / Exports / Common / Catalog / KubernetesClusterPrometheusMetrics

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#interface-kubernetesclusterprometheusmetrics","title":"Interface: KubernetesClusterPrometheusMetrics","text":"

Common.Catalog.KubernetesClusterPrometheusMetrics

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#properties","title":"Properties","text":"
  • address
  • type
"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#address","title":"address","text":"

\u2022 Optional address: Object

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#type-declaration","title":"Type declaration","text":"Name Type namespace string port number prefix string service string"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#type","title":"type","text":"

\u2022 Optional type: string

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/","title":"Common.Catalog.KubernetesClusterSpec","text":"

@k8slens/extensions / Exports / Common / Catalog / KubernetesClusterSpec

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#interface-kubernetesclusterspec","title":"Interface: KubernetesClusterSpec","text":"

Common.Catalog.KubernetesClusterSpec

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#hierarchy","title":"Hierarchy","text":"
  • CatalogEntitySpec

\u21b3 KubernetesClusterSpec

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#properties","title":"Properties","text":"
  • accessibleNamespaces
  • icon
  • kubeconfigContext
  • kubeconfigPath
  • metrics
"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#accessiblenamespaces","title":"accessibleNamespaces","text":"

\u2022 Optional accessibleNamespaces: string[]

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#icon","title":"icon","text":"

\u2022 Optional icon: Object

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#type-declaration","title":"Type declaration","text":"Name Type background? string material? string src? string"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#kubeconfigcontext","title":"kubeconfigContext","text":"

\u2022 kubeconfigContext: string

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#kubeconfigpath","title":"kubeconfigPath","text":"

\u2022 kubeconfigPath: string

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#metrics","title":"metrics","text":"

\u2022 Optional metrics: Object

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#type-declaration_1","title":"Type declaration","text":"Name Type prometheus? KubernetesClusterPrometheusMetrics source string"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/","title":"Common.Catalog.KubernetesClusterStatus","text":"

@k8slens/extensions / Exports / Common / Catalog / KubernetesClusterStatus

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#interface-kubernetesclusterstatus","title":"Interface: KubernetesClusterStatus","text":"

Common.Catalog.KubernetesClusterStatus

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#hierarchy","title":"Hierarchy","text":"
  • CatalogEntityStatus

\u21b3 KubernetesClusterStatus

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#properties","title":"Properties","text":"
  • active
  • enabled
  • message
  • phase
  • reason
"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#active","title":"active","text":"

\u2022 Optional active: boolean

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#inherited-from","title":"Inherited from","text":"

CatalogEntityStatus.active

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#enabled","title":"enabled","text":"

\u2022 Optional enabled: boolean

Default

true\n
"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#inherited-from_1","title":"Inherited from","text":"

CatalogEntityStatus.enabled

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#message","title":"message","text":"

\u2022 Optional message: string

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#inherited-from_2","title":"Inherited from","text":"

CatalogEntityStatus.message

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#phase","title":"phase","text":"

\u2022 phase: string

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#inherited-from_3","title":"Inherited from","text":"

CatalogEntityStatus.phase

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#reason","title":"reason","text":"

\u2022 Optional reason: string

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#inherited-from_4","title":"Inherited from","text":"

CatalogEntityStatus.reason

"},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/","title":"Common.Catalog.TitleCellProps","text":"

@k8slens/extensions / Exports / Common / Catalog / TitleCellProps

"},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/#interface-titlecellprops","title":"Interface: TitleCellProps","text":"

Common.Catalog.TitleCellProps

These are the supported props for the title cell

"},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/#properties","title":"Properties","text":"
  • className
  • data-testid
  • title
"},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/#data-testid","title":"data-testid","text":"

\u2022 Optional data-testid: string

"},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/#title","title":"title","text":"

\u2022 title: string

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkSpec/","title":"Common.Catalog.WebLinkSpec","text":"

@k8slens/extensions / Exports / Common / Catalog / WebLinkSpec

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkSpec/#interface-weblinkspec","title":"Interface: WebLinkSpec","text":"

Common.Catalog.WebLinkSpec

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkSpec/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkSpec/#properties","title":"Properties","text":"
  • url
"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkSpec/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkSpec/#url","title":"url","text":"

\u2022 url: string

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/","title":"Common.Catalog.WebLinkStatus","text":"

@k8slens/extensions / Exports / Common / Catalog / WebLinkStatus

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#interface-weblinkstatus","title":"Interface: WebLinkStatus","text":"

Common.Catalog.WebLinkStatus

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#hierarchy","title":"Hierarchy","text":"
  • CatalogEntityStatus

\u21b3 WebLinkStatus

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#properties","title":"Properties","text":"
  • active
  • enabled
  • message
  • phase
  • reason
"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#active","title":"active","text":"

\u2022 Optional active: boolean

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#inherited-from","title":"Inherited from","text":"

CatalogEntityStatus.active

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#enabled","title":"enabled","text":"

\u2022 Optional enabled: boolean

Default

true\n
"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#inherited-from_1","title":"Inherited from","text":"

CatalogEntityStatus.enabled

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#message","title":"message","text":"

\u2022 Optional message: string

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#inherited-from_2","title":"Inherited from","text":"

CatalogEntityStatus.message

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#phase","title":"phase","text":"

\u2022 phase: WebLinkStatusPhase

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#overrides","title":"Overrides","text":"

CatalogEntityStatus.phase

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#reason","title":"reason","text":"

\u2022 Optional reason: string

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#inherited-from_3","title":"Inherited from","text":"

CatalogEntityStatus.reason

"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/","title":"Common.EventBus.AppEvent","text":"

@k8slens/extensions / Exports / Common / EventBus / AppEvent

"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#interface-appevent","title":"Interface: AppEvent","text":"

Common.EventBus.AppEvent

Data for telemetry

"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#properties","title":"Properties","text":"
  • action
  • destination
  • name
  • params
"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#action","title":"action","text":"

\u2022 action: string

"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#destination","title":"destination","text":"

\u2022 Optional destination: string

"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#name","title":"name","text":"

\u2022 name: string

"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#params","title":"params","text":"

\u2022 Optional params: Record<string, any>

"},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/","title":"Common.EventBus.EventEmitterOptions","text":"

@k8slens/extensions / Exports / Common / EventBus / EventEmitterOptions

"},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/#interface-eventemitteroptions","title":"Interface: EventEmitterOptions","text":"

Common.EventBus.EventEmitterOptions

"},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/#properties","title":"Properties","text":"
  • once
  • prepend
"},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/#once","title":"once","text":"

\u2022 Optional once: boolean

"},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/#prepend","title":"prepend","text":"

\u2022 Optional prepend: boolean

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/","title":"Common.LensExtensionManifest","text":"

@k8slens/extensions / Exports / Common / LensExtensionManifest

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#interface-lensextensionmanifest","title":"Interface: LensExtensionManifest","text":"

Common.LensExtensionManifest

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#hierarchy","title":"Hierarchy","text":"
  • BundledLensExtensionManifest

\u21b3 LensExtensionManifest

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#properties","title":"Properties","text":"
  • description
  • engines
  • main
  • name
  • publishConfig
  • renderer
  • storeName
  • version
"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#description","title":"description","text":"

\u2022 Optional description: string

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#inherited-from","title":"Inherited from","text":"

BundledLensExtensionManifest.description

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#engines","title":"engines","text":"

\u2022 engines: Object

Supported Lens version engine by extension could be defined in manifest.engines.lens Only MAJOR.MINOR version is taken in consideration.

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#index-signature","title":"Index signature","text":"

\u25aa [x: string]: string | undefined

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#type-declaration","title":"Type declaration","text":"Name Type lens string"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#main","title":"main","text":"

\u2022 Optional main: string

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#name","title":"name","text":"

\u2022 name: string

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#inherited-from_1","title":"Inherited from","text":"

BundledLensExtensionManifest.name

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#publishconfig","title":"publishConfig","text":"

\u2022 Optional publishConfig: Partial<Record<string, string>>

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#inherited-from_2","title":"Inherited from","text":"

BundledLensExtensionManifest.publishConfig

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#renderer","title":"renderer","text":"

\u2022 Optional renderer: string

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#storename","title":"storeName","text":"

\u2022 Optional storeName: string

Specify extension name used for persisting data. Useful if extension is renamed but the data should not be lost.

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#inherited-from_3","title":"Inherited from","text":"

BundledLensExtensionManifest.storeName

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#version","title":"version","text":"

\u2022 version: string

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#inherited-from_4","title":"Inherited from","text":"

BundledLensExtensionManifest.version

"},{"location":"extensions/api/interfaces/Common.Logger/","title":"Common.Logger","text":"

@k8slens/extensions / Exports / Common / Logger

"},{"location":"extensions/api/interfaces/Common.Logger/#interface-logger","title":"Interface: Logger","text":"

Common.Logger

Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.

"},{"location":"extensions/api/interfaces/Common.Logger/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Logger/#properties","title":"Properties","text":"
  • debug
  • error
  • info
  • silly
  • warn
"},{"location":"extensions/api/interfaces/Common.Logger/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Logger/#debug","title":"debug","text":"

\u2022 debug: (message: string, ...args: any) => void

"},{"location":"extensions/api/interfaces/Common.Logger/#type-declaration","title":"Type declaration","text":"

\u25b8 (message, ...args): void

"},{"location":"extensions/api/interfaces/Common.Logger/#parameters","title":"Parameters","text":"Name Type message string ...args any"},{"location":"extensions/api/interfaces/Common.Logger/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Logger/#error","title":"error","text":"

\u2022 error: (message: string, ...args: any) => void

"},{"location":"extensions/api/interfaces/Common.Logger/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (message, ...args): void

"},{"location":"extensions/api/interfaces/Common.Logger/#parameters_1","title":"Parameters","text":"Name Type message string ...args any"},{"location":"extensions/api/interfaces/Common.Logger/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Logger/#info","title":"info","text":"

\u2022 info: (message: string, ...args: any) => void

"},{"location":"extensions/api/interfaces/Common.Logger/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (message, ...args): void

"},{"location":"extensions/api/interfaces/Common.Logger/#parameters_2","title":"Parameters","text":"Name Type message string ...args any"},{"location":"extensions/api/interfaces/Common.Logger/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Logger/#silly","title":"silly","text":"

\u2022 silly: (message: string, ...args: any) => void

"},{"location":"extensions/api/interfaces/Common.Logger/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (message, ...args): void

"},{"location":"extensions/api/interfaces/Common.Logger/#parameters_3","title":"Parameters","text":"Name Type message string ...args any"},{"location":"extensions/api/interfaces/Common.Logger/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Logger/#warn","title":"warn","text":"

\u2022 warn: (message: string, ...args: any) => void

"},{"location":"extensions/api/interfaces/Common.Logger/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (message, ...args): void

"},{"location":"extensions/api/interfaces/Common.Logger/#parameters_4","title":"Parameters","text":"Name Type message string ...args any"},{"location":"extensions/api/interfaces/Common.Logger/#returns_4","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/","title":"Common.Store.ExtensionStoreParams","text":"

@k8slens/extensions / Exports / Common / Store / ExtensionStoreParams

"},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#interface-extensionstoreparamst","title":"Interface: ExtensionStoreParams<T>","text":"

Common.Store.ExtensionStoreParams

"},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#type-parameters","title":"Type parameters","text":"Name Type T extends object"},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#hierarchy","title":"Hierarchy","text":"
  • Omit<PersistentStorageParams<T>, \"migrations\" | \"cwd\" | \"fromStore\" | \"toJSON\">

\u21b3 ExtensionStoreParams

"},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#properties","title":"Properties","text":"
  • configName
  • cwd
  • migrations
  • syncOptions
"},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#configname","title":"configName","text":"

\u2022 Readonly configName: string

"},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#inherited-from","title":"Inherited from","text":"

Omit.configName

"},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#cwd","title":"cwd","text":"

\u2022 Optional cwd: string

"},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#migrations","title":"migrations","text":"

\u2022 Optional migrations: Migrations<T>

"},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#syncoptions","title":"syncOptions","text":"

\u2022 Optional Readonly syncOptions: Object

"},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#type-declaration","title":"Type declaration","text":"Name Type equals? IEqualsComparer<T> fireImmediately? boolean"},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#inherited-from_1","title":"Inherited from","text":"

Omit.syncOptions

"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/","title":"Common.Store.PersistentStorageParams","text":"

@k8slens/extensions / Exports / Common / Store / PersistentStorageParams

"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#interface-persistentstorageparamst","title":"Interface: PersistentStorageParams<T>","text":"

Common.Store.PersistentStorageParams

"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#type-parameters","title":"Type parameters","text":"Name Type T extends object"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#hierarchy","title":"Hierarchy","text":"
  • Omit<Options<T>, \"migrations\">

\u21b3 PersistentStorageParams

"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#properties","title":"Properties","text":"
  • configName
  • migrations
  • syncOptions
"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#methods","title":"Methods","text":"
  • fromStore
  • toJSON
"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#configname","title":"configName","text":"

\u2022 Readonly configName: string

"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#overrides","title":"Overrides","text":"

Omit.configName

"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#migrations","title":"migrations","text":"

\u2022 Optional Readonly migrations: Partial<Record<string, (store: MigrationStore) => void>>

"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#syncoptions","title":"syncOptions","text":"

\u2022 Optional Readonly syncOptions: Object

"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#type-declaration","title":"Type declaration","text":"Name Type equals? IEqualsComparer<T> fireImmediately? boolean"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#fromstore","title":"fromStore","text":"

\u25b8 fromStore(data): void

fromStore is called internally when a child class syncs with the file system.

Note: This function must be synchronous.

"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#parameters","title":"Parameters","text":"Name Type Description data Partial<T> the parsed information read from the stored JSON file"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#tojson","title":"toJSON","text":"

\u25b8 toJSON(): T

toJSON is called when syncing the store to the filesystem. It should produce a JSON serializable object representation of the current state.

It is recommended that a round trip is valid. Namely, calling this.fromStore(this.toJSON()) shouldn't change the state.

"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#returns_1","title":"Returns","text":"

T

"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/","title":"Common.Types.AppPreferenceComponents","text":"

@k8slens/extensions / Exports / Common / Types / AppPreferenceComponents

"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/#interface-apppreferencecomponents","title":"Interface: AppPreferenceComponents","text":"

Common.Types.AppPreferenceComponents

"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/#properties","title":"Properties","text":"
  • Hint
  • Input
"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/#hint","title":"Hint","text":"

\u2022 Hint: ComponentType<any>

"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/#input","title":"Input","text":"

\u2022 Input: ComponentType<any>

"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/","title":"Common.Types.AppPreferenceRegistration","text":"

@k8slens/extensions / Exports / Common / Types / AppPreferenceRegistration

"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#interface-apppreferenceregistration","title":"Interface: AppPreferenceRegistration","text":"

Common.Types.AppPreferenceRegistration

"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#properties","title":"Properties","text":"
  • components
  • id
  • showInPreferencesTab
  • title
"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#components","title":"components","text":"

\u2022 components: AppPreferenceComponents

"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#id","title":"id","text":"

\u2022 Optional id: string

"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#showinpreferencestab","title":"showInPreferencesTab","text":"

\u2022 Optional showInPreferencesTab: string

"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#title","title":"title","text":"

\u2022 title: string

"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/","title":"Common.Types.ClusterPageMenuComponents","text":"

@k8slens/extensions / Exports / Common / Types / ClusterPageMenuComponents

"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/#interface-clusterpagemenucomponents","title":"Interface: ClusterPageMenuComponents","text":"

Common.Types.ClusterPageMenuComponents

"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/#properties","title":"Properties","text":"
  • Icon
"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/#icon","title":"Icon","text":"

\u2022 Icon: ComponentType<IconProps>

"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/","title":"Common.Types.ClusterPageMenuRegistration","text":"

@k8slens/extensions / Exports / Common / Types / ClusterPageMenuRegistration

"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#interface-clusterpagemenuregistration","title":"Interface: ClusterPageMenuRegistration","text":"

Common.Types.ClusterPageMenuRegistration

"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#properties","title":"Properties","text":"
  • components
  • id
  • orderNumber
  • parentId
  • target
  • title
  • visible
"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#components","title":"components","text":"

\u2022 components: ClusterPageMenuComponents

"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#id","title":"id","text":"

\u2022 Optional id: string

"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#ordernumber","title":"orderNumber","text":"

\u2022 Optional orderNumber: number

"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#parentid","title":"parentId","text":"

\u2022 Optional parentId: string

"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#target","title":"target","text":"

\u2022 Optional target: PageTarget

"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#title","title":"title","text":"

\u2022 title: ReactNode

"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#visible","title":"visible","text":"

\u2022 Optional visible: IComputedValue<boolean>

"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/","title":"Common.Types.CustomCategoryViewComponents","text":"

@k8slens/extensions / Exports / Common / Types / CustomCategoryViewComponents

"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/#interface-customcategoryviewcomponents","title":"Interface: CustomCategoryViewComponents","text":"

Common.Types.CustomCategoryViewComponents

The components for the category view.

"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/#properties","title":"Properties","text":"
  • View
"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/#view","title":"View","text":"

\u2022 View: ComponentType<CustomCategoryViewProps>

"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewProps/","title":"Common.Types.CustomCategoryViewProps","text":"

@k8slens/extensions / Exports / Common / Types / CustomCategoryViewProps

"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewProps/#interface-customcategoryviewprops","title":"Interface: CustomCategoryViewProps","text":"

Common.Types.CustomCategoryViewProps

The props for CustomCategoryViewComponents.View

"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewProps/#properties","title":"Properties","text":"
  • category
"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewProps/#category","title":"category","text":"

\u2022 category: CatalogCategory

The category instance itself

"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/","title":"Common.Types.CustomCategoryViewRegistration","text":"

@k8slens/extensions / Exports / Common / Types / CustomCategoryViewRegistration

"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#interface-customcategoryviewregistration","title":"Interface: CustomCategoryViewRegistration","text":"

Common.Types.CustomCategoryViewRegistration

This is the type used to declare additional views for a specific category

"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#properties","title":"Properties","text":"
  • components
  • group
  • kind
  • priority
"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#components","title":"components","text":"

\u2022 components: CustomCategoryViewComponents

The components for this registration

"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#group","title":"group","text":"

\u2022 group: string

The catalog entity group that is declared by the category for this registration

e.g. - \"entity.k8slens.dev\"

"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#kind","title":"kind","text":"

\u2022 kind: string

The catalog entity kind that is declared by the category for this registration

e.g. - \"KubernetesCluster\"

"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#priority","title":"priority","text":"

\u2022 Optional priority: number

The sorting order value. Used to determine the total order of the views.

Default

50\n
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/","title":"Common.Types.KubeObjectContextMenuItem","text":"

@k8slens/extensions / Exports / Common / Types / KubeObjectContextMenuItem

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#interface-kubeobjectcontextmenuitem","title":"Interface: KubeObjectContextMenuItem","text":"

Common.Types.KubeObjectContextMenuItem

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#properties","title":"Properties","text":"
  • icon
  • id
  • onClick
  • title
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#icon","title":"icon","text":"

\u2022 icon: string | BaseIconProps

If the type is string then it is shorthand for material

This is required because this item can be either rendered as a context menu or as a toolbar in the kube object details page.

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#id","title":"id","text":"

\u2022 Optional id: string

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#onclick","title":"onClick","text":"

\u2022 onClick: (obj: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>) => void

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#type-declaration","title":"Type declaration","text":"

\u25b8 (obj): void

The action when clicked

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#parameters","title":"Parameters","text":"Name Type obj KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#title","title":"title","text":"

\u2022 title: string

The title text for the menu item or the hover text for the icon.

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/","title":"Common.Types.KubeObjectDetailComponents","text":"

@k8slens/extensions / Exports / Common / Types / KubeObjectDetailComponents

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/#interface-kubeobjectdetailcomponentst","title":"Interface: KubeObjectDetailComponents<T>","text":"

Common.Types.KubeObjectDetailComponents

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/#type-parameters","title":"Type parameters","text":"Name Type T extends KubeObject = KubeObject"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/#properties","title":"Properties","text":"
  • Details
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/#details","title":"Details","text":"

\u2022 Details: ComponentType<KubeObjectDetailsProps<T>>

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/","title":"Common.Types.KubeObjectDetailRegistration","text":"

@k8slens/extensions / Exports / Common / Types / KubeObjectDetailRegistration

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#interface-kubeobjectdetailregistrationt","title":"Interface: KubeObjectDetailRegistration<T>","text":"

Common.Types.KubeObjectDetailRegistration

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#type-parameters","title":"Type parameters","text":"Name Type T extends KubeObject = KubeObject"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#properties","title":"Properties","text":"
  • apiVersions
  • components
  • kind
  • priority
  • visible
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#apiversions","title":"apiVersions","text":"

\u2022 apiVersions: string[]

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#components","title":"components","text":"

\u2022 components: KubeObjectDetailComponents<T>

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#priority","title":"priority","text":"

\u2022 Optional priority: number

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#visible","title":"visible","text":"

\u2022 Optional visible: IComputedValue<boolean>

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectHandlers/","title":"Common.Types.KubeObjectHandlers","text":"

@k8slens/extensions / Exports / Common / Types / KubeObjectHandlers

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectHandlers/#interface-kubeobjecthandlers","title":"Interface: KubeObjectHandlers","text":"

Common.Types.KubeObjectHandlers

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectHandlers/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectHandlers/#properties","title":"Properties","text":"
  • onContextMenuOpen
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectHandlers/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectHandlers/#oncontextmenuopen","title":"onContextMenuOpen","text":"

\u2022 onContextMenuOpen: KubeObjectOnContextMenuOpen

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/","title":"Common.Types.KubeObjectMenuComponents","text":"

@k8slens/extensions / Exports / Common / Types / KubeObjectMenuComponents

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/#interface-kubeobjectmenucomponents","title":"Interface: KubeObjectMenuComponents","text":"

Common.Types.KubeObjectMenuComponents

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/#properties","title":"Properties","text":"
  • MenuItem
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/#menuitem","title":"MenuItem","text":"

\u2022 MenuItem: ComponentType<KubeObjectMenuItemProps>

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/","title":"Common.Types.KubeObjectMenuRegistration","text":"

@k8slens/extensions / Exports / Common / Types / KubeObjectMenuRegistration

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#interface-kubeobjectmenuregistration","title":"Interface: KubeObjectMenuRegistration","text":"

Common.Types.KubeObjectMenuRegistration

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#properties","title":"Properties","text":"
  • apiVersions
  • components
  • kind
  • visible
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#apiversions","title":"apiVersions","text":"

\u2022 apiVersions: string[]

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#components","title":"components","text":"

\u2022 components: KubeObjectMenuComponents

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#visible","title":"visible","text":"

\u2022 Optional visible: IComputedValue<boolean>

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/","title":"Common.Types.KubeObjectOnContextMenuOpenContext","text":"

@k8slens/extensions / Exports / Common / Types / KubeObjectOnContextMenuOpenContext

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#interface-kubeobjectoncontextmenuopencontext","title":"Interface: KubeObjectOnContextMenuOpenContext","text":"

Common.Types.KubeObjectOnContextMenuOpenContext

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#properties","title":"Properties","text":"
  • menuItems
  • navigate
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#menuitems","title":"menuItems","text":"

\u2022 Readonly menuItems: IObservableArray<KubeObjectContextMenuItem>

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#navigate","title":"navigate","text":"

\u2022 navigate: (location: string) => void

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#type-declaration","title":"Type declaration","text":"

\u25b8 (location): void

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#parameters","title":"Parameters","text":"Name Type location string"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/","title":"Common.Types.KubeObjectStatusRegistration","text":"

@k8slens/extensions / Exports / Common / Types / KubeObjectStatusRegistration

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#interface-kubeobjectstatusregistration","title":"Interface: KubeObjectStatusRegistration","text":"

Common.Types.KubeObjectStatusRegistration

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#properties","title":"Properties","text":"
  • apiVersions
  • kind
  • resolve
  • visible
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#apiversions","title":"apiVersions","text":"

\u2022 apiVersions: string[]

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#resolve","title":"resolve","text":"

\u2022 resolve: (object: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>) => KubeObjectStatus

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#type-declaration","title":"Type declaration","text":"

\u25b8 (object): KubeObjectStatus

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#parameters","title":"Parameters","text":"Name Type object KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#returns","title":"Returns","text":"

KubeObjectStatus

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#visible","title":"visible","text":"

\u2022 Optional visible: IComputedValue<boolean>

"},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/","title":"Common.Types.PageComponentProps","text":"

@k8slens/extensions / Exports / Common / Types / PageComponentProps

"},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/#interface-pagecomponentpropsp","title":"Interface: PageComponentProps<P>","text":"

Common.Types.PageComponentProps

"},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/#type-parameters","title":"Type parameters","text":"Name Type P extends PageParams = {}"},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/#properties","title":"Properties","text":"
  • params
"},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/#params","title":"params","text":"

\u2022 Optional params: { [N in string | number | symbol]: PageParam<P[N]> }

"},{"location":"extensions/api/interfaces/Common.Types.PageComponents/","title":"Common.Types.PageComponents","text":"

@k8slens/extensions / Exports / Common / Types / PageComponents

"},{"location":"extensions/api/interfaces/Common.Types.PageComponents/#interface-pagecomponents","title":"Interface: PageComponents","text":"

Common.Types.PageComponents

"},{"location":"extensions/api/interfaces/Common.Types.PageComponents/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.PageComponents/#properties","title":"Properties","text":"
  • Page
"},{"location":"extensions/api/interfaces/Common.Types.PageComponents/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.PageComponents/#page","title":"Page","text":"

\u2022 Page: ComponentType<any>

"},{"location":"extensions/api/interfaces/Common.Types.PageParams/","title":"Common.Types.PageParams","text":"

@k8slens/extensions / Exports / Common / Types / PageParams

"},{"location":"extensions/api/interfaces/Common.Types.PageParams/#interface-pageparamsv","title":"Interface: PageParams<V>","text":"

Common.Types.PageParams

"},{"location":"extensions/api/interfaces/Common.Types.PageParams/#type-parameters","title":"Type parameters","text":"Name Type V any"},{"location":"extensions/api/interfaces/Common.Types.PageParams/#indexable","title":"Indexable","text":"

\u25aa [paramName: string]: V

"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/","title":"Common.Types.PageRegistration","text":"

@k8slens/extensions / Exports / Common / Types / PageRegistration

"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#interface-pageregistration","title":"Interface: PageRegistration","text":"

Common.Types.PageRegistration

"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#properties","title":"Properties","text":"
  • components
  • enabled
  • id
  • params
"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#components","title":"components","text":"

\u2022 components: PageComponents

"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#enabled","title":"enabled","text":"

\u2022 Optional enabled: IComputedValue<boolean>

"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#id","title":"id","text":"

\u2022 Optional id: string

Page ID, part of extension's page url, must be unique within same extension When not provided, first registered page without \"id\" would be used for page-menus without target.pageId for same extension

"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#params","title":"params","text":"

\u2022 Optional params: PageParams<string | Omit<PageParamInit<any>, \"name\" | \"prefix\">>

"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/","title":"Common.Types.PageTarget","text":"

@k8slens/extensions / Exports / Common / Types / PageTarget

"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#interface-pagetarget","title":"Interface: PageTarget","text":"

Common.Types.PageTarget

"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#properties","title":"Properties","text":"
  • extensionId
  • pageId
  • params
"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#extensionid","title":"extensionId","text":"

\u2022 Optional extensionId: string

"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#pageid","title":"pageId","text":"

\u2022 Optional pageId: string

"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#params","title":"params","text":"

\u2022 Optional params: PageParams<any>

"},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/","title":"Common.Types.ProtocolHandlerRegistration","text":"

@k8slens/extensions / Exports / Common / Types / ProtocolHandlerRegistration

"},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/#interface-protocolhandlerregistration","title":"Interface: ProtocolHandlerRegistration","text":"

Common.Types.ProtocolHandlerRegistration

ProtocolHandlerRegistration is the data required for an extension to register a handler to a specific path or dynamic path.

"},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/#properties","title":"Properties","text":"
  • handler
  • pathSchema
"},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/#handler","title":"handler","text":"

\u2022 handler: ProtocolRouteHandler

"},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/#pathschema","title":"pathSchema","text":"

\u2022 pathSchema: string

"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteHandler/","title":"Common.Types.ProtocolRouteHandler","text":"

@k8slens/extensions / Exports / Common / Types / ProtocolRouteHandler

"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteHandler/#interface-protocolroutehandler","title":"Interface: ProtocolRouteHandler","text":"

Common.Types.ProtocolRouteHandler

"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteHandler/#callable","title":"Callable","text":""},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteHandler/#protocolroutehandler","title":"ProtocolRouteHandler","text":"

\u25b8 ProtocolRouteHandler(params): void

RouteHandler represents the function signature of the handler function for lens:// protocol routing.

"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteHandler/#parameters","title":"Parameters","text":"Name Type params ProtocolRouteParams"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteHandler/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/","title":"Common.Types.ProtocolRouteParams","text":"

@k8slens/extensions / Exports / Common / Types / ProtocolRouteParams

"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#interface-protocolrouteparams","title":"Interface: ProtocolRouteParams","text":"

Common.Types.ProtocolRouteParams

The collection of the dynamic parts of a URI which initiated a lens:// protocol request

"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#properties","title":"Properties","text":"
  • pathname
  • search
  • tail
"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#pathname","title":"pathname","text":"

\u2022 pathname: Record<string, undefined | string>

the matching parts of the path. The dynamic parts of the URI path.

"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#search","title":"search","text":"

\u2022 search: Record<string, undefined | string>

the parts of the URI query string

"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#tail","title":"tail","text":"

\u2022 Optional tail: string

if the most specific path schema that is matched does not cover the whole of the URI's path. Then this field will be set to the remaining path segments.

Example:

If the path schema /landing/:type is the matched schema for the URI /landing/soft/easy then this field will be set to \"/easy\".

"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/","title":"Common.Types.RegisteredPage","text":"

@k8slens/extensions / Exports / Common / Types / RegisteredPage

"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#interface-registeredpage","title":"Interface: RegisteredPage","text":"

Common.Types.RegisteredPage

"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#properties","title":"Properties","text":"
  • components
  • extensionId
  • id
  • params
  • url
"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#components","title":"components","text":"

\u2022 components: PageComponents

"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#extensionid","title":"extensionId","text":"

\u2022 extensionId: string

"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#id","title":"id","text":"

\u2022 id: string

"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#params","title":"params","text":"

\u2022 params: PageParams<PageParam<any>>

"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#url","title":"url","text":"

\u2022 url: string

"},{"location":"extensions/api/interfaces/Common.Types.ShellEnvContext/","title":"Common.Types.ShellEnvContext","text":"

@k8slens/extensions / Exports / Common / Types / ShellEnvContext

"},{"location":"extensions/api/interfaces/Common.Types.ShellEnvContext/#interface-shellenvcontext","title":"Interface: ShellEnvContext","text":"

Common.Types.ShellEnvContext

"},{"location":"extensions/api/interfaces/Common.Types.ShellEnvContext/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.ShellEnvContext/#properties","title":"Properties","text":"
  • catalogEntity
"},{"location":"extensions/api/interfaces/Common.Types.ShellEnvContext/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.ShellEnvContext/#catalogentity","title":"catalogEntity","text":"

\u2022 catalogEntity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>

"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/","title":"Common.Types.StatusBarRegistration","text":"

@k8slens/extensions / Exports / Common / Types / StatusBarRegistration

"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#interface-statusbarregistration","title":"Interface: StatusBarRegistration","text":"

Common.Types.StatusBarRegistration

The type for registering status bar items from the LensRendererExtension

"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#properties","title":"Properties","text":"
  • components
  • item
  • visible
"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#components","title":"components","text":"

\u2022 Optional components: StatusBarComponents

The newer API, allows for registering a component instead of a ReactNode

"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#item","title":"item","text":"

\u2022 Optional item: ReactNode | () => ReactNode

Deprecated

use components instead

"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#visible","title":"visible","text":"

\u2022 Optional visible: IComputedValue<boolean>

If specified, controls item visibility

"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/","title":"Common.Types.TrayMenuRegistration","text":"

@k8slens/extensions / Exports / Common / Types / TrayMenuRegistration

"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#interface-traymenuregistration","title":"Interface: TrayMenuRegistration","text":"

Common.Types.TrayMenuRegistration

"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#properties","title":"Properties","text":"
  • click
  • enabled
  • id
  • label
  • submenu
  • toolTip
  • type
  • visible
"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#click","title":"click","text":"

\u2022 Optional click: (menuItem: TrayMenuRegistration) => void

"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#type-declaration","title":"Type declaration","text":"

\u25b8 (menuItem): void

"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#parameters","title":"Parameters","text":"Name Type menuItem TrayMenuRegistration"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#enabled","title":"enabled","text":"

\u2022 Optional enabled: boolean | IComputedValue<boolean>

"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#id","title":"id","text":"

\u2022 Optional id: string

"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#label","title":"label","text":"

\u2022 Optional label: string | IComputedValue<string>

"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#submenu","title":"submenu","text":"

\u2022 Optional submenu: TrayMenuRegistration[]

"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#tooltip","title":"toolTip","text":"

\u2022 Optional toolTip: string

"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#type","title":"type","text":"

\u2022 Optional type: \"submenu\" | \"normal\" | \"separator\"

"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#visible","title":"visible","text":"

\u2022 Optional visible: IComputedValue<boolean>

"},{"location":"extensions/api/interfaces/Common.Util.Disposable/","title":"Common.Util.Disposable","text":"

@k8slens/extensions / Exports / Common / Util / Disposable

"},{"location":"extensions/api/interfaces/Common.Util.Disposable/#interface-disposable","title":"Interface: Disposable","text":"

Common.Util.Disposable

"},{"location":"extensions/api/interfaces/Common.Util.Disposable/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Util.Disposable/#methods","title":"Methods","text":"
  • dispose
"},{"location":"extensions/api/interfaces/Common.Util.Disposable/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Common.Util.Disposable/#dispose","title":"dispose","text":"

\u25b8 dispose(): void

"},{"location":"extensions/api/interfaces/Common.Util.Disposable/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Util.Disposer/","title":"Common.Util.Disposer","text":"

@k8slens/extensions / Exports / Common / Util / Disposer

"},{"location":"extensions/api/interfaces/Common.Util.Disposer/#interface-disposer","title":"Interface: Disposer","text":"

Common.Util.Disposer

"},{"location":"extensions/api/interfaces/Common.Util.Disposer/#hierarchy","title":"Hierarchy","text":"
  • Disposer

\u21b3 ExtendableDisposer

"},{"location":"extensions/api/interfaces/Common.Util.Disposer/#callable","title":"Callable","text":""},{"location":"extensions/api/interfaces/Common.Util.Disposer/#disposer","title":"Disposer","text":"

\u25b8 Disposer(): void

"},{"location":"extensions/api/interfaces/Common.Util.Disposer/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/","title":"Common.Util.ExtendableDisposer","text":"

@k8slens/extensions / Exports / Common / Util / ExtendableDisposer

"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#interface-extendabledisposer","title":"Interface: ExtendableDisposer","text":"

Common.Util.ExtendableDisposer

"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#hierarchy","title":"Hierarchy","text":"
  • Disposer

\u21b3 ExtendableDisposer

"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#callable","title":"Callable","text":""},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#extendabledisposer","title":"ExtendableDisposer","text":"

\u25b8 ExtendableDisposer(): void

"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#methods","title":"Methods","text":"
  • push
"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#push","title":"push","text":"

\u25b8 push(...values): void

"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#parameters","title":"Parameters","text":"Name Type ...values (Disposer | ExtendableDisposer | Disposable)[]"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/","title":"Main.Catalog.CatalogEntityRegistry","text":"

@k8slens/extensions / Exports / Main / Catalog / CatalogEntityRegistry

"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#interface-catalogentityregistry","title":"Interface: CatalogEntityRegistry","text":"

Main.Catalog.CatalogEntityRegistry

"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#methods","title":"Methods","text":"
  • getItemsForApiKind
"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#getitemsforapikind","title":"getItemsForApiKind","text":"

\u25b8 getItemsForApiKind(apiVersion, kind): CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>[]

"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#parameters","title":"Parameters","text":"Name Type apiVersion string kind string"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#returns","title":"Returns","text":"

CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>[]

\u25b8 getItemsForApiKind<T>(apiVersion, kind): T[]

Deprecated

use a cast instead of a unbounded type parameter

"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#type-parameters","title":"Type parameters","text":"Name Type T extends CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec, T>"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#parameters_1","title":"Parameters","text":"Name Type apiVersion string kind string"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#returns_1","title":"Returns","text":"

T[]

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/","title":"Main.K8sApi.BaseKubeJsonApiObjectMetadata","text":"

@k8slens/extensions / Exports / Main / K8sApi / BaseKubeJsonApiObjectMetadata

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#interface-basekubejsonapiobjectmetadatanamespaced","title":"Interface: BaseKubeJsonApiObjectMetadata<Namespaced>","text":"

Main.K8sApi.BaseKubeJsonApiObjectMetadata

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#type-parameters","title":"Type parameters","text":"Name Type Namespaced extends KubeObjectScope"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#indexable","title":"Indexable","text":"

\u25aa [key: string]: unknown

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#properties","title":"Properties","text":"
  • annotations
  • clusterName
  • creationTimestamp
  • deletionGracePeriodSeconds
  • deletionTimestamp
  • finalizers
  • generateName
  • generation
  • labels
  • managedFields
  • name
  • namespace
  • ownerReferences
  • resourceVersion
  • selfLink
  • uid
"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#annotations","title":"annotations","text":"

\u2022 Optional annotations: Partial<Record<string, string>>

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

More info: http://kubernetes.io/docs/user-guide/annotations

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#clustername","title":"clusterName","text":"

\u2022 Optional clusterName: string

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 and api server is going to ignore it if set in create or update request.

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#creationtimestamp","title":"creationTimestamp","text":"

\u2022 Optional Readonly creationTimestamp: string

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#deletiongraceperiodseconds","title":"deletionGracePeriodSeconds","text":"

\u2022 Optional Readonly deletionGracePeriodSeconds: number

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened.

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#deletiontimestamp","title":"deletionTimestamp","text":"

\u2022 Optional Readonly deletionTimestamp: string

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#finalizers","title":"finalizers","text":"

\u2022 Optional finalizers: string[]

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#generatename","title":"generateName","text":"

\u2022 Optional generateName: string

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#generation","title":"generation","text":"

\u2022 Optional Readonly generation: number

A sequence number representing a specific generation of the desired state. Populated by the system.

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#labels","title":"labels","text":"

\u2022 Optional labels: Partial<Record<string, string>>

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services.

More info: http://kubernetes.io/docs/user-guide/labels

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#managedfields","title":"managedFields","text":"

\u2022 Optional managedFields: unknown[]

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object.

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#name","title":"name","text":"

\u2022 Readonly name: string

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition.

More info: http://kubernetes.io/docs/user-guide/identifiers#names

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#namespace","title":"namespace","text":"

\u2022 Optional Readonly namespace: ScopedNamespace<Namespaced>

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#ownerreferences","title":"ownerReferences","text":"

\u2022 Optional ownerReferences: OwnerReference[]

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#resourceversion","title":"resourceVersion","text":"

\u2022 Optional Readonly resourceVersion: string

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Value must be treated as opaque by clients.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#selflink","title":"selfLink","text":"

\u2022 Optional Readonly selfLink: string

SelfLink is a URL representing this object. Populated by the system.

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#uid","title":"uid","text":"

\u2022 Optional Readonly uid: string

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system.

More info: http://kubernetes.io/docs/user-guide/identifiers#uids

"},{"location":"extensions/api/interfaces/Main.K8sApi.ExternalKubeApiOptions/","title":"Main.K8sApi.ExternalKubeApiOptions","text":"

@k8slens/extensions / Exports / Main / K8sApi / ExternalKubeApiOptions

"},{"location":"extensions/api/interfaces/Main.K8sApi.ExternalKubeApiOptions/#interface-externalkubeapioptions","title":"Interface: ExternalKubeApiOptions","text":"

Main.K8sApi.ExternalKubeApiOptions

"},{"location":"extensions/api/interfaces/Main.K8sApi.ExternalKubeApiOptions/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.ExternalKubeApiOptions/#properties","title":"Properties","text":"
  • autoRegister
"},{"location":"extensions/api/interfaces/Main.K8sApi.ExternalKubeApiOptions/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.ExternalKubeApiOptions/#autoregister","title":"autoRegister","text":"

\u2022 Optional autoRegister: boolean

If true then on creation of the KubeApiinstance a call to apiManager.registerApi will be made. This is true by default to maintain backwards compatibility.

Setting this to false might make KubeObject's details drawer stop working.

Default

true\n
"},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/","title":"Main.K8sApi.IKubeApiCluster","text":"

@k8slens/extensions / Exports / Main / K8sApi / IKubeApiCluster

"},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/#interface-ikubeapicluster","title":"Interface: IKubeApiCluster","text":"

Main.K8sApi.IKubeApiCluster

Deprecated

This type is unused

"},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/#properties","title":"Properties","text":"
  • metadata
"},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/#metadata","title":"metadata","text":"

\u2022 metadata: Object

"},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/#type-declaration","title":"Type declaration","text":"Name Type uid string"},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/","title":"Main.K8sApi.ILocalKubeApiConfig","text":"

@k8slens/extensions / Exports / Main / K8sApi / ILocalKubeApiConfig

"},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/#interface-ilocalkubeapiconfig","title":"Interface: ILocalKubeApiConfig","text":"

Main.K8sApi.ILocalKubeApiConfig

"},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/#properties","title":"Properties","text":"
  • metadata
"},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/#metadata","title":"metadata","text":"

\u2022 metadata: Object

"},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/#type-declaration","title":"Type declaration","text":"Name Type uid string"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/","title":"Main.K8sApi.IPodContainer","text":"

@k8slens/extensions / Exports / Main / K8sApi / IPodContainer

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#interface-ipodcontainer","title":"Interface: IPodContainer","text":"

Main.K8sApi.IPodContainer

A single application container that you want to run within a pod.

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#properties","title":"Properties","text":"
  • args
  • command
  • env
  • envFrom
  • image
  • imagePullPolicy
  • lifecycle
  • livenessProbe
  • name
  • ports
  • readinessProbe
  • resources
  • securityContext
  • startupProbe
  • stdin
  • stdinOnce
  • terminationMessagePath
  • terminationMessagePolicy
  • tty
  • volumeDevices
  • volumeMounts
  • workingDir
"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#args","title":"args","text":"

\u2022 Optional args: string[]

Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment.

If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\".

Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated.

More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#command","title":"command","text":"

\u2022 Optional command: string[]

Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment.

If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\".

Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated.

More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#env","title":"env","text":"

\u2022 Optional env: EnvVar[]

List of environment variables to set in the container. Cannot be updated.

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#envfrom","title":"envFrom","text":"

\u2022 Optional envFrom: EnvFromSource[]

List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting.

When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#image","title":"image","text":"

\u2022 Optional image: string

Docker image name.

More info: https://kubernetes.io/docs/concepts/containers/images

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#imagepullpolicy","title":"imagePullPolicy","text":"

\u2022 Optional imagePullPolicy: \"Always\" | \"Never\" | \"IfNotPresent\"

Image pull policy. Defaults to \"Always\" if :latest tag is specified, or \"IfNotPresent\" otherwise. Cannot be updated.

More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#lifecycle","title":"lifecycle","text":"

\u2022 Optional lifecycle: Lifecycle

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#livenessprobe","title":"livenessProbe","text":"

\u2022 Optional livenessProbe: Probe

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#name","title":"name","text":"

\u2022 name: string

Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#ports","title":"ports","text":"

\u2022 Optional ports: ContainerPort[]

List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated.

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#readinessprobe","title":"readinessProbe","text":"

\u2022 Optional readinessProbe: Probe

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#resources","title":"resources","text":"

\u2022 Optional resources: ResourceRequirements

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#securitycontext","title":"securityContext","text":"

\u2022 Optional securityContext: SecurityContext

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#startupprobe","title":"startupProbe","text":"

\u2022 Optional startupProbe: Probe

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#stdin","title":"stdin","text":"

\u2022 Optional stdin: boolean

Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF.

Default

false\n
"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#stdinonce","title":"stdinOnce","text":"

\u2022 Optional stdinOnce: boolean

Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions.

If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted.

If this flag is false, a container processes that reads from stdin will never receive an EOF.

Default

false\n
"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#terminationmessagepath","title":"terminationMessagePath","text":"

\u2022 Optional terminationMessagePath: string

Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message.

Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Cannot be updated.

Default

\"/dev/termination-log\"\n
"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#terminationmessagepolicy","title":"terminationMessagePolicy","text":"

\u2022 Optional terminationMessagePolicy: \"File\" | \"FallbackToLogsOnError\"

Indicate how the termination message should be populated.

  • File: will use the contents of terminationMessagePath to populate the container status message on both success and failure.

  • FallbackToLogsOnError: will use the last chunk of container log output if the termination message file is empty and the container exited with an error.

The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Cannot be updated.

Default

\"File\"\n
"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#tty","title":"tty","text":"

\u2022 Optional tty: boolean

Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.

Default

false\n
"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#volumedevices","title":"volumeDevices","text":"

\u2022 Optional volumeDevices: VolumeDevice[]

volumeDevices is the list of block devices to be used by the container.

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#volumemounts","title":"volumeMounts","text":"

\u2022 Optional volumeMounts: VolumeMount[]

Pod volumes to mount into the container's filesystem. Cannot be updated.

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#workingdir","title":"workingDir","text":"

\u2022 Optional workingDir: string

Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/","title":"Main.K8sApi.IPodContainerStatus","text":"

@k8slens/extensions / Exports / Main / K8sApi / IPodContainerStatus

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#interface-ipodcontainerstatus","title":"Interface: IPodContainerStatus","text":"

Main.K8sApi.IPodContainerStatus

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#properties","title":"Properties","text":"
  • containerID
  • image
  • imageID
  • lastState
  • name
  • ready
  • restartCount
  • started
  • state
"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#containerid","title":"containerID","text":"

\u2022 Optional containerID: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#image","title":"image","text":"

\u2022 image: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#imageid","title":"imageID","text":"

\u2022 imageID: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#laststate","title":"lastState","text":"

\u2022 Optional lastState: ContainerState

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#name","title":"name","text":"

\u2022 name: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#ready","title":"ready","text":"

\u2022 ready: boolean

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#restartcount","title":"restartCount","text":"

\u2022 restartCount: number

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#started","title":"started","text":"

\u2022 Optional started: boolean

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#state","title":"state","text":"

\u2022 Optional state: ContainerState

"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/","title":"Main.K8sApi.IRemoteKubeApiConfig","text":"

@k8slens/extensions / Exports / Main / K8sApi / IRemoteKubeApiConfig

"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#interface-iremotekubeapiconfig","title":"Interface: IRemoteKubeApiConfig","text":"

Main.K8sApi.IRemoteKubeApiConfig

"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#properties","title":"Properties","text":"
  • agent
  • cluster
  • user
"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#agent","title":"agent","text":"

\u2022 Optional agent: Agent

Custom instance of https.agent to use for the requests

Remarks

the custom agent replaced default agent, options skipTLSVerify, clientCertificateData, clientKeyData and caData are ignored.

"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#cluster","title":"cluster","text":"

\u2022 cluster: Object

"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#type-declaration","title":"Type declaration","text":"Name Type caData? string server string skipTLSVerify? boolean"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#user","title":"user","text":"

\u2022 user: Object

"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#type-declaration_1","title":"Type declaration","text":"Name Type clientCertificateData? string clientKeyData? string token? string | () => Promise<string>"},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/","title":"Main.K8sApi.ISecretRef","text":"

@k8slens/extensions / Exports / Main / K8sApi / ISecretRef

"},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/#interface-isecretref","title":"Interface: ISecretRef","text":"

Main.K8sApi.ISecretRef

"},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/#properties","title":"Properties","text":"
  • name
  • namespace
"},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/#name","title":"name","text":"

\u2022 name: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/#namespace","title":"namespace","text":"

\u2022 Optional namespace: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/","title":"Main.K8sApi.IgnoredKubeApiOptions","text":"

@k8slens/extensions / Exports / Main / K8sApi / IgnoredKubeApiOptions

"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#interface-ignoredkubeapioptions","title":"Interface: IgnoredKubeApiOptions","text":"

Main.K8sApi.IgnoredKubeApiOptions

Deprecated

This type is only present for backwards compatible typescript support

"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#properties","title":"Properties","text":"
  • apiBase
  • isNamespaces
  • kind
  • objectConstructor
"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#apibase","title":"apiBase","text":"

\u2022 Optional apiBase: any

Deprecated

this option is overridden and should not be used

"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#isnamespaces","title":"isNamespaces","text":"

\u2022 Optional isNamespaces: any

Deprecated

this option is overridden and should not be used

"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#kind","title":"kind","text":"

\u2022 Optional kind: any

Deprecated

this option is overridden and should not be used

"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#objectconstructor","title":"objectConstructor","text":"

\u2022 Optional objectConstructor: any

Deprecated

this option is overridden and should not be used

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/","title":"Main.K8sApi.KubeJsonApiData","text":"

@k8slens/extensions / Exports / Main / K8sApi / KubeJsonApiData

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#interface-kubejsonapidatametadata-status-spec","title":"Interface: KubeJsonApiData<Metadata, Status, Spec>","text":"

Main.K8sApi.KubeJsonApiData

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeJsonApiObjectMetadata = KubeJsonApiObjectMetadata Status unknown Spec unknown"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#indexable","title":"Indexable","text":"

\u25aa [otherKeys: string]: unknown

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#metadata","title":"metadata","text":"

\u2022 metadata: Metadata

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#spec","title":"spec","text":"

\u2022 Optional spec: Spec

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#status","title":"status","text":"

\u2022 Optional status: Status

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/","title":"Main.K8sApi.KubeObjectStoreLoadAllParams","text":"

@k8slens/extensions / Exports / Main / K8sApi / KubeObjectStoreLoadAllParams

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#interface-kubeobjectstoreloadallparams","title":"Interface: KubeObjectStoreLoadAllParams","text":"

Main.K8sApi.KubeObjectStoreLoadAllParams

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#properties","title":"Properties","text":"
  • merge
  • namespaces
  • onLoadFailure
  • reqInit
"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#merge","title":"merge","text":"

\u2022 Optional merge: boolean

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#namespaces","title":"namespaces","text":"

\u2022 Optional namespaces: string[]

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#onloadfailure","title":"onLoadFailure","text":"

\u2022 Optional onLoadFailure: OnLoadFailure

A function that is called when listing fails. If set then blocks errors being rejected with

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#reqinit","title":"reqInit","text":"

\u2022 Optional reqInit: RequestInit

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/","title":"Main.K8sApi.KubeObjectStoreLoadingParams","text":"

@k8slens/extensions / Exports / Main / K8sApi / KubeObjectStoreLoadingParams

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#interface-kubeobjectstoreloadingparams","title":"Interface: KubeObjectStoreLoadingParams","text":"

Main.K8sApi.KubeObjectStoreLoadingParams

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#properties","title":"Properties","text":"
  • namespaces
  • onLoadFailure
  • reqInit
"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#namespaces","title":"namespaces","text":"

\u2022 namespaces: string[]

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#onloadfailure","title":"onLoadFailure","text":"

\u2022 Optional onLoadFailure: OnLoadFailure

A function that is called when listing fails. If set then blocks errors being rejected with

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#reqinit","title":"reqInit","text":"

\u2022 Optional reqInit: RequestInit

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/","title":"Main.K8sApi.KubeObjectStoreSubscribeParams","text":"

@k8slens/extensions / Exports / Main / K8sApi / KubeObjectStoreSubscribeParams

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/#interface-kubeobjectstoresubscribeparams","title":"Interface: KubeObjectStoreSubscribeParams","text":"

Main.K8sApi.KubeObjectStoreSubscribeParams

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/#properties","title":"Properties","text":"
  • abortController
  • onLoadFailure
"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/#abortcontroller","title":"abortController","text":"

\u2022 Optional abortController: AbortController

An optional parent abort controller

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/#onloadfailure","title":"onLoadFailure","text":"

\u2022 Optional onLoadFailure: OnLoadFailure

A function that is called when listing fails. If set then blocks errors being rejected with

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/","title":"Main.K8sApi.KubeStatusData","text":"

@k8slens/extensions / Exports / Main / K8sApi / KubeStatusData

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#interface-kubestatusdata","title":"Interface: KubeStatusData","text":"

Main.K8sApi.KubeStatusData

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#properties","title":"Properties","text":"
  • apiVersion
  • code
  • kind
  • message
  • reason
  • status
"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#code","title":"code","text":"

\u2022 code: number

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#message","title":"message","text":"

\u2022 Optional message: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#reason","title":"reason","text":"

\u2022 Optional reason: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#status","title":"status","text":"

\u2022 Optional status: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/","title":"Main.K8sApi.OwnerReference","text":"

@k8slens/extensions / Exports / Main / K8sApi / OwnerReference

"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#interface-ownerreference","title":"Interface: OwnerReference","text":"

Main.K8sApi.OwnerReference

"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#properties","title":"Properties","text":"
  • apiVersion
  • blockOwnerDeletion
  • controller
  • kind
  • name
  • uid
"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#blockownerdeletion","title":"blockOwnerDeletion","text":"

\u2022 Optional blockOwnerDeletion: boolean

"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#controller","title":"controller","text":"

\u2022 Optional controller: boolean

"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#name","title":"name","text":"

\u2022 name: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#uid","title":"uid","text":"

\u2022 uid: string

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/","title":"Renderer.Component.AdditionalCategoryColumnRegistration","text":"

@k8slens/extensions / Exports / Renderer / Component / AdditionalCategoryColumnRegistration

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#interface-additionalcategorycolumnregistration","title":"Interface: AdditionalCategoryColumnRegistration","text":"

Renderer.Component.AdditionalCategoryColumnRegistration

This is the type used to declare new catalog category columns

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#hierarchy","title":"Hierarchy","text":"
  • CategoryColumnRegistration

\u21b3 AdditionalCategoryColumnRegistration

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#properties","title":"Properties","text":"
  • group
  • id
  • kind
  • priority
  • renderCell
  • searchFilter
  • sortCallback
  • titleProps
"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#group","title":"group","text":"

\u2022 group: string

The catalog entity group that is declared by the category for this registration

e.g. - \"entity.k8slens.dev\"

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#id","title":"id","text":"

\u2022 id: string

This value MUST to be unique to your extension

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#inherited-from","title":"Inherited from","text":"

CategoryColumnRegistration.id

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#kind","title":"kind","text":"

\u2022 kind: string

The catalog entity kind that is declared by the category for this registration

e.g. - \"KubernetesCluster\"

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#priority","title":"priority","text":"

\u2022 Optional priority: number

The sorting order value.

Default

50\n
"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#inherited-from_1","title":"Inherited from","text":"

CategoryColumnRegistration.priority

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#rendercell","title":"renderCell","text":"

\u2022 renderCell: (entity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>) => ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#type-declaration","title":"Type declaration","text":"

\u25b8 (entity): ReactNode

This function will be called to generate the cells (on demand) for the column

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#parameters","title":"Parameters","text":"Name Type entity CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#returns","title":"Returns","text":"

ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#inherited-from_2","title":"Inherited from","text":"

CategoryColumnRegistration.renderCell

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#searchfilter","title":"searchFilter","text":"

\u2022 Optional searchFilter: (entity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>) => string | string[]

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (entity): string | string[]

If provided then searching is supported on this column and this function will be called to determine if the current search string matches for this row.

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#parameters_1","title":"Parameters","text":"Name Type entity CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#returns_1","title":"Returns","text":"

string | string[]

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#inherited-from_3","title":"Inherited from","text":"

CategoryColumnRegistration.searchFilter

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#sortcallback","title":"sortCallback","text":"

\u2022 Optional sortCallback: (entity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>) => string | number | (string | number)[]

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (entity): string | number | (string | number)[]

If provided then the column will support sorting and this function will be called to determine a row's ordering.

strings are sorted ahead of numbers, and arrays determine ordering between equal elements of the previous index.

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#parameters_2","title":"Parameters","text":"Name Type entity CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#returns_2","title":"Returns","text":"

string | number | (string | number)[]

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#inherited-from_4","title":"Inherited from","text":"

CategoryColumnRegistration.sortCallback

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#titleprops","title":"titleProps","text":"

\u2022 titleProps: TitleCellProps

This function will be used to generate the columns title cell.

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#inherited-from_5","title":"Inherited from","text":"

CategoryColumnRegistration.titleProps

"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/","title":"Renderer.Component.BadgeProps","text":"

@k8slens/extensions / Exports / Renderer / Component / BadgeProps

"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#interface-badgeprops","title":"Interface: BadgeProps","text":"

Renderer.Component.BadgeProps

"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#hierarchy","title":"Hierarchy","text":"
  • HTMLAttributes<HTMLDivElement>

\u21b3 BadgeProps

"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#properties","title":"Properties","text":"
  • disabled
  • expandable
  • flat
  • label
  • scrollable
  • small
"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#disabled","title":"disabled","text":"

\u2022 Optional disabled: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#expandable","title":"expandable","text":"

\u2022 Optional expandable: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#flat","title":"flat","text":"

\u2022 Optional flat: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#label","title":"label","text":"

\u2022 Optional label: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#scrollable","title":"scrollable","text":"

\u2022 Optional scrollable: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#small","title":"small","text":"

\u2022 Optional small: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/","title":"Renderer.Component.BarChartProps","text":"

@k8slens/extensions / Exports / Renderer / Component / BarChartProps

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#interface-barchartprops","title":"Interface: BarChartProps","text":"

Renderer.Component.BarChartProps

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#hierarchy","title":"Hierarchy","text":"
  • ChartProps

\u21b3 BarChartProps

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#properties","title":"Properties","text":"
  • className
  • data
  • data-testid
  • height
  • legendColors
  • legendPosition
  • name
  • options
  • plugins
  • redraw
  • showChart
  • showLegend
  • timeLabelStep
  • title
  • type
  • width
"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#inherited-from","title":"Inherited from","text":"

ChartProps.className

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#data","title":"data","text":"

\u2022 data: ChartData

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#inherited-from_1","title":"Inherited from","text":"

ChartProps.data

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#data-testid","title":"data-testid","text":"

\u2022 Optional data-testid: string

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#inherited-from_2","title":"Inherited from","text":"

ChartProps.data-testid

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#height","title":"height","text":"

\u2022 Optional height: string | number

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#inherited-from_3","title":"Inherited from","text":"

ChartProps.height

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#legendcolors","title":"legendColors","text":"

\u2022 Optional legendColors: string[]

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#inherited-from_4","title":"Inherited from","text":"

ChartProps.legendColors

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#legendposition","title":"legendPosition","text":"

\u2022 Optional legendPosition: \"bottom\"

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#inherited-from_5","title":"Inherited from","text":"

ChartProps.legendPosition

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#name","title":"name","text":"

\u2022 Optional name: string

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#options","title":"options","text":"

\u2022 Optional options: ChartOptions

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#inherited-from_6","title":"Inherited from","text":"

ChartProps.options

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#plugins","title":"plugins","text":"

\u2022 Optional plugins: PluginServiceRegistrationOptions[]

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#inherited-from_7","title":"Inherited from","text":"

ChartProps.plugins

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#redraw","title":"redraw","text":"

\u2022 Optional redraw: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#inherited-from_8","title":"Inherited from","text":"

ChartProps.redraw

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#showchart","title":"showChart","text":"

\u2022 Optional showChart: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#inherited-from_9","title":"Inherited from","text":"

ChartProps.showChart

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#showlegend","title":"showLegend","text":"

\u2022 Optional showLegend: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#inherited-from_10","title":"Inherited from","text":"

ChartProps.showLegend

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#timelabelstep","title":"timeLabelStep","text":"

\u2022 Optional timeLabelStep: number

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#title","title":"title","text":"

\u2022 Optional title: string

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#inherited-from_11","title":"Inherited from","text":"

ChartProps.title

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#type","title":"type","text":"

\u2022 Optional type: ChartKind

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#inherited-from_12","title":"Inherited from","text":"

ChartProps.type

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#width","title":"width","text":"

\u2022 Optional width: string | number

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#inherited-from_13","title":"Inherited from","text":"

ChartProps.width

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/","title":"Renderer.Component.BaseIconProps","text":"

@k8slens/extensions / Exports / Renderer / Component / BaseIconProps

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#interface-baseiconprops","title":"Interface: BaseIconProps","text":"

Renderer.Component.BaseIconProps

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#hierarchy","title":"Hierarchy","text":"
  • BaseIconProps

\u21b3 IconProps

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#properties","title":"Properties","text":"
  • active
  • big
  • data-testid
  • disabled
  • focusable
  • href
  • interactive
  • link
  • material
  • size
  • small
  • smallest
  • sticker
  • svg
"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#active","title":"active","text":"

\u2022 Optional active: boolean

apply active-state styles

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#big","title":"big","text":"

\u2022 Optional big: boolean

A pre-defined icon-size

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#data-testid","title":"data-testid","text":"

\u2022 Optional data-testid: string

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#disabled","title":"disabled","text":"

\u2022 Optional disabled: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#focusable","title":"focusable","text":"

\u2022 Optional focusable: boolean

Allow focus to the icon to show .active styles. Only applicable if interactive is true.

Default

true\n
"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#href","title":"href","text":"

\u2022 Optional href: string

render icon as hyperlink

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#interactive","title":"interactive","text":"

\u2022 Optional interactive: boolean

indicates that icon is interactive and highlight it on focus/hover

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#link","title":"link","text":"

\u2022 Optional link: LocationDescriptor<unknown>

render icon as NavLink from react-router-dom

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#material","title":"material","text":"

\u2022 Optional material: string

One of the names from https://material.io/icons/

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#size","title":"size","text":"

\u2022 Optional size: string | number

The icon size (css units)

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#small","title":"small","text":"

\u2022 Optional small: boolean

A pre-defined icon-size

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#smallest","title":"smallest","text":"

\u2022 Optional smallest: boolean

A pre-defined icon-size

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#sticker","title":"sticker","text":"

\u2022 Optional sticker: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#svg","title":"svg","text":"

\u2022 Optional svg: string

Either an SVG XML or one of NamedSvg

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/","title":"Renderer.Component.ButtonProps","text":"

@k8slens/extensions / Exports / Renderer / Component / ButtonProps

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#interface-buttonprops","title":"Interface: ButtonProps","text":"

Renderer.Component.ButtonProps

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#hierarchy","title":"Hierarchy","text":"
  • ButtonHTMLAttributes<any>

\u21b3 ButtonProps

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#properties","title":"Properties","text":"
  • accent
  • active
  • big
  • hidden
  • href
  • label
  • light
  • outlined
  • plain
  • primary
  • round
  • target
  • waiting
"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#accent","title":"accent","text":"

\u2022 Optional accent: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#active","title":"active","text":"

\u2022 Optional active: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#big","title":"big","text":"

\u2022 Optional big: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#hidden","title":"hidden","text":"

\u2022 Optional hidden: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#overrides","title":"Overrides","text":"

ButtonHTMLAttributes.hidden

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#href","title":"href","text":"

\u2022 Optional href: string

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#label","title":"label","text":"

\u2022 Optional label: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#light","title":"light","text":"

\u2022 Optional light: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#outlined","title":"outlined","text":"

\u2022 Optional outlined: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#plain","title":"plain","text":"

\u2022 Optional plain: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#primary","title":"primary","text":"

\u2022 Optional primary: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#round","title":"round","text":"

\u2022 Optional round: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#target","title":"target","text":"

\u2022 Optional target: \"_blank\"

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#waiting","title":"waiting","text":"

\u2022 Optional waiting: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/","title":"Renderer.Component.CheckboxProps","text":"

@k8slens/extensions / Exports / Renderer / Component / CheckboxProps

"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#interface-checkboxprops","title":"Interface: CheckboxProps","text":"

Renderer.Component.CheckboxProps

"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#properties","title":"Properties","text":"
  • children
  • className
  • disabled
  • inline
  • label
  • value
"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#methods","title":"Methods","text":"
  • onChange
"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#children","title":"children","text":"

\u2022 Optional children: SingleOrMany<ReactChild | ReactFragment>

"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#disabled","title":"disabled","text":"

\u2022 Optional disabled: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#inline","title":"inline","text":"

\u2022 Optional inline: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#label","title":"label","text":"

\u2022 Optional label: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#value","title":"value","text":"

\u2022 Optional value: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#onchange","title":"onChange","text":"

\u25b8 Optional onChange(value, evt): void

"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#parameters","title":"Parameters","text":"Name Type value boolean evt ChangeEvent<HTMLInputElement>"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/","title":"Renderer.Component.ConfirmDialogBooleanParams","text":"

@k8slens/extensions / Exports / Renderer / Component / ConfirmDialogBooleanParams

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#interface-confirmdialogbooleanparams","title":"Interface: ConfirmDialogBooleanParams","text":"

Renderer.Component.ConfirmDialogBooleanParams

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#hierarchy","title":"Hierarchy","text":"
  • ConfirmDialogBooleanParams

\u21b3 ConfirmDialogParams

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#properties","title":"Properties","text":"
  • cancelButtonProps
  • icon
  • labelCancel
  • labelOk
  • message
  • okButtonProps
"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#cancelbuttonprops","title":"cancelButtonProps","text":"

\u2022 Optional cancelButtonProps: Partial<ButtonProps>

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#icon","title":"icon","text":"

\u2022 Optional icon: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#labelcancel","title":"labelCancel","text":"

\u2022 Optional labelCancel: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#labelok","title":"labelOk","text":"

\u2022 Optional labelOk: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#message","title":"message","text":"

\u2022 message: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#okbuttonprops","title":"okButtonProps","text":"

\u2022 Optional okButtonProps: Partial<ButtonProps>

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/","title":"Renderer.Component.ConfirmDialogParams","text":"

@k8slens/extensions / Exports / Renderer / Component / ConfirmDialogParams

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#interface-confirmdialogparams","title":"Interface: ConfirmDialogParams","text":"

Renderer.Component.ConfirmDialogParams

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#hierarchy","title":"Hierarchy","text":"
  • ConfirmDialogBooleanParams

\u21b3 ConfirmDialogParams

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#properties","title":"Properties","text":"
  • cancel
  • cancelButtonProps
  • icon
  • labelCancel
  • labelOk
  • message
  • ok
  • okButtonProps
"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#cancel","title":"cancel","text":"

\u2022 Optional cancel: () => any

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#type-declaration","title":"Type declaration","text":"

\u25b8 (): any

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#returns","title":"Returns","text":"

any

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#cancelbuttonprops","title":"cancelButtonProps","text":"

\u2022 Optional cancelButtonProps: Partial<ButtonProps>

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#inherited-from","title":"Inherited from","text":"

ConfirmDialogBooleanParams.cancelButtonProps

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#icon","title":"icon","text":"

\u2022 Optional icon: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#inherited-from_1","title":"Inherited from","text":"

ConfirmDialogBooleanParams.icon

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#labelcancel","title":"labelCancel","text":"

\u2022 Optional labelCancel: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#inherited-from_2","title":"Inherited from","text":"

ConfirmDialogBooleanParams.labelCancel

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#labelok","title":"labelOk","text":"

\u2022 Optional labelOk: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#inherited-from_3","title":"Inherited from","text":"

ConfirmDialogBooleanParams.labelOk

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#message","title":"message","text":"

\u2022 message: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#inherited-from_4","title":"Inherited from","text":"

ConfirmDialogBooleanParams.message

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#ok","title":"ok","text":"

\u2022 Optional ok: () => any

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (): any

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#returns_1","title":"Returns","text":"

any

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#okbuttonprops","title":"okButtonProps","text":"

\u2022 Optional okButtonProps: Partial<ButtonProps>

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#inherited-from_5","title":"Inherited from","text":"

ConfirmDialogBooleanParams.okButtonProps

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/","title":"Renderer.Component.ConfirmDialogProps","text":"

@k8slens/extensions / Exports / Renderer / Component / ConfirmDialogProps

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#interface-confirmdialogprops","title":"Interface: ConfirmDialogProps","text":"

Renderer.Component.ConfirmDialogProps

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#hierarchy","title":"Hierarchy","text":"
  • Partial<DialogProps>

\u21b3 ConfirmDialogProps

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#properties","title":"Properties","text":"
  • animated
  • children
  • className
  • close
  • data-testid
  • isOpen
  • modal
  • onClose
  • onOpen
  • open
  • pinned
"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#animated","title":"animated","text":"

\u2022 Optional animated: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#inherited-from","title":"Inherited from","text":"

Partial.animated

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#children","title":"children","text":"

\u2022 Optional children: ReactNode | ReactNode[]

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#inherited-from_1","title":"Inherited from","text":"

Partial.children

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#inherited-from_2","title":"Inherited from","text":"

Partial.className

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#close","title":"close","text":"

\u2022 Optional close: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#type-declaration","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#inherited-from_3","title":"Inherited from","text":"

Partial.close

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#data-testid","title":"data-testid","text":"

\u2022 Optional data-testid: string

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#inherited-from_4","title":"Inherited from","text":"

Partial.data-testid

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#isopen","title":"isOpen","text":"

\u2022 Optional isOpen: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#inherited-from_5","title":"Inherited from","text":"

Partial.isOpen

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#modal","title":"modal","text":"

\u2022 Optional modal: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#inherited-from_6","title":"Inherited from","text":"

Partial.modal

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#onclose","title":"onClose","text":"

\u2022 Optional onClose: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#inherited-from_7","title":"Inherited from","text":"

Partial.onClose

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#onopen","title":"onOpen","text":"

\u2022 Optional onOpen: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#inherited-from_8","title":"Inherited from","text":"

Partial.onOpen

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#open","title":"open","text":"

\u2022 Optional open: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#inherited-from_9","title":"Inherited from","text":"

Partial.open

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#pinned","title":"pinned","text":"

\u2022 Optional pinned: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#inherited-from_10","title":"Inherited from","text":"

Partial.pinned

"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/","title":"Renderer.Component.CreateNotificationOptions","text":"

@k8slens/extensions / Exports / Renderer / Component / CreateNotificationOptions

"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#interface-createnotificationoptions","title":"Interface: CreateNotificationOptions","text":"

Renderer.Component.CreateNotificationOptions

"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#properties","title":"Properties","text":"
  • id
  • timeout
"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#methods","title":"Methods","text":"
  • onClose
"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#id","title":"id","text":"

\u2022 Optional id: NotificationId

"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#timeout","title":"timeout","text":"

\u2022 Optional timeout: number

"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#onclose","title":"onClose","text":"

\u25b8 Optional onClose(): void

"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.CustomPlaceholderProps/","title":"Renderer.Component.CustomPlaceholderProps","text":"

@k8slens/extensions / Exports / Renderer / Component / CustomPlaceholderProps

"},{"location":"extensions/api/interfaces/Renderer.Component.CustomPlaceholderProps/#interface-customplaceholderprops","title":"Interface: CustomPlaceholderProps","text":"

Renderer.Component.CustomPlaceholderProps

"},{"location":"extensions/api/interfaces/Renderer.Component.CustomPlaceholderProps/#hierarchy","title":"Hierarchy","text":"
  • PlaceholderProps<NamespaceSelectFilterOption, true>

\u21b3 CustomPlaceholderProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/","title":"Renderer.Component.DialogProps","text":"

@k8slens/extensions / Exports / Renderer / Component / DialogProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#interface-dialogprops","title":"Interface: DialogProps","text":"

Renderer.Component.DialogProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#properties","title":"Properties","text":"
  • animated
  • children
  • className
  • close
  • data-testid
  • isOpen
  • modal
  • onClose
  • onOpen
  • open
  • pinned
"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#animated","title":"animated","text":"

\u2022 Optional animated: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#children","title":"children","text":"

\u2022 Optional children: ReactNode | ReactNode[]

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#close","title":"close","text":"

\u2022 Optional close: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#type-declaration","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#data-testid","title":"data-testid","text":"

\u2022 Optional data-testid: string

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#isopen","title":"isOpen","text":"

\u2022 Optional isOpen: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#modal","title":"modal","text":"

\u2022 Optional modal: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#onclose","title":"onClose","text":"

\u2022 Optional onClose: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#onopen","title":"onOpen","text":"

\u2022 Optional onOpen: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#open","title":"open","text":"

\u2022 Optional open: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#pinned","title":"pinned","text":"

\u2022 Optional pinned: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/","title":"Renderer.Component.DrawerItemLabelsProps","text":"

@k8slens/extensions / Exports / Renderer / Component / DrawerItemLabelsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#interface-draweritemlabelsprops","title":"Interface: DrawerItemLabelsProps","text":"

Renderer.Component.DrawerItemLabelsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#hierarchy","title":"Hierarchy","text":"
  • DrawerItemProps

\u21b3 DrawerItemLabelsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#properties","title":"Properties","text":"
  • hidden
  • labels
  • labelsOnly
  • name
  • renderBooleans
  • title
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#hidden","title":"hidden","text":"

\u2022 Optional hidden: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#inherited-from","title":"Inherited from","text":"

DrawerItemProps.hidden

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#labels","title":"labels","text":"

\u2022 labels: string[] | Partial<Record<string, string>>

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#labelsonly","title":"labelsOnly","text":"

\u2022 Optional labelsOnly: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#inherited-from_1","title":"Inherited from","text":"

DrawerItemProps.labelsOnly

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#name","title":"name","text":"

\u2022 name: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#inherited-from_2","title":"Inherited from","text":"

DrawerItemProps.name

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#renderbooleans","title":"renderBooleans","text":"

\u2022 Optional renderBooleans: boolean

Deprecated

This prop is no longer used, you should stringify the booleans yourself.

This was only meant to be an internal prop anyway.

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#inherited-from_3","title":"Inherited from","text":"

DrawerItemProps.renderBooleans

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#title","title":"title","text":"

\u2022 Optional title: string

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#inherited-from_4","title":"Inherited from","text":"

DrawerItemProps.title

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/","title":"Renderer.Component.DrawerItemProps","text":"

@k8slens/extensions / Exports / Renderer / Component / DrawerItemProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#interface-draweritemprops","title":"Interface: DrawerItemProps","text":"

Renderer.Component.DrawerItemProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#hierarchy","title":"Hierarchy","text":"
  • HTMLAttributes<HTMLDivElement>

\u21b3 DrawerItemProps

\u21b3\u21b3 DrawerItemLabelsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#properties","title":"Properties","text":"
  • hidden
  • labelsOnly
  • name
  • renderBooleans
  • title
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#hidden","title":"hidden","text":"

\u2022 Optional hidden: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#overrides","title":"Overrides","text":"

React.HTMLAttributes.hidden

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#labelsonly","title":"labelsOnly","text":"

\u2022 Optional labelsOnly: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#name","title":"name","text":"

\u2022 name: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#renderbooleans","title":"renderBooleans","text":"

\u2022 Optional renderBooleans: boolean

Deprecated

This prop is no longer used, you should stringify the booleans yourself.

This was only meant to be an internal prop anyway.

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#title","title":"title","text":"

\u2022 Optional title: string

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#overrides_1","title":"Overrides","text":"

React.HTMLAttributes.title

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/","title":"Renderer.Component.DrawerParamTogglerProps","text":"

@k8slens/extensions / Exports / Renderer / Component / DrawerParamTogglerProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/#interface-drawerparamtogglerprops","title":"Interface: DrawerParamTogglerProps","text":"

Renderer.Component.DrawerParamTogglerProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/#properties","title":"Properties","text":"
  • children
  • label
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/#children","title":"children","text":"

\u2022 children: ReactNode | ReactNode[]

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/#label","title":"label","text":"

\u2022 label: string | number

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/","title":"Renderer.Component.DrawerProps","text":"

@k8slens/extensions / Exports / Renderer / Component / DrawerProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#interface-drawerprops","title":"Interface: DrawerProps","text":"

Renderer.Component.DrawerProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#properties","title":"Properties","text":"
  • animation
  • children
  • className
  • contentClass
  • data-testid
  • onClose
  • open
  • position
  • size
  • testIdForClose
  • title
  • toolbar
  • usePortal
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#animation","title":"animation","text":"

\u2022 Optional animation: string

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#children","title":"children","text":"

\u2022 Optional children: SingleOrMany<ReactNode>

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#classname","title":"className","text":"

\u2022 Optional className: string | object

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#contentclass","title":"contentClass","text":"

\u2022 Optional contentClass: string | object

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#data-testid","title":"data-testid","text":"

\u2022 Optional data-testid: string

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#onclose","title":"onClose","text":"

\u2022 Optional onClose: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#type-declaration","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#open","title":"open","text":"

\u2022 open: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#position","title":"position","text":"

\u2022 Optional position: DrawerPosition

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#size","title":"size","text":"

\u2022 Optional size: string

The width or heigh (depending on position) of the Drawer.

If not set then the Drawer will be resizable.

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#testidforclose","title":"testIdForClose","text":"

\u2022 Optional testIdForClose: string

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#title","title":"title","text":"

\u2022 title: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#toolbar","title":"toolbar","text":"

\u2022 Optional toolbar: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#useportal","title":"usePortal","text":"

\u2022 Optional usePortal: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/","title":"Renderer.Component.DrawerTitleProps","text":"

@k8slens/extensions / Exports / Renderer / Component / DrawerTitleProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#interface-drawertitleprops","title":"Interface: DrawerTitleProps","text":"

Renderer.Component.DrawerTitleProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#properties","title":"Properties","text":"
  • children
  • className
  • size
  • title
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#children","title":"children","text":"

\u2022 Optional children: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#size","title":"size","text":"

\u2022 Optional size: \"title\" | \"sub-title\"

Specifies how large this title is

Default

\"title\"\n
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#title","title":"title","text":"

\u2022 Optional title: ReactNode

Deprecated

Prefer passing the value as children

"},{"location":"extensions/api/interfaces/Renderer.Component.IconDataFnArg/","title":"Renderer.Component.IconDataFnArg","text":"

@k8slens/extensions / Exports / Renderer / Component / IconDataFnArg

"},{"location":"extensions/api/interfaces/Renderer.Component.IconDataFnArg/#interface-icondatafnarg","title":"Interface: IconDataFnArg","text":"

Renderer.Component.IconDataFnArg

"},{"location":"extensions/api/interfaces/Renderer.Component.IconDataFnArg/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.IconDataFnArg/#properties","title":"Properties","text":"
  • isDirty
"},{"location":"extensions/api/interfaces/Renderer.Component.IconDataFnArg/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.IconDataFnArg/#isdirty","title":"isDirty","text":"

\u2022 isDirty: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/","title":"Renderer.Component.IconProps","text":"

@k8slens/extensions / Exports / Renderer / Component / IconProps

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#interface-iconprops","title":"Interface: IconProps","text":"

Renderer.Component.IconProps

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#hierarchy","title":"Hierarchy","text":"
  • HTMLAttributes<any>

  • BaseIconProps

\u21b3 IconProps

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#properties","title":"Properties","text":"
  • active
  • big
  • data-testid
  • disabled
  • focusable
  • href
  • interactive
  • link
  • material
  • size
  • small
  • smallest
  • sticker
  • svg
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#active","title":"active","text":"

\u2022 Optional active: boolean

apply active-state styles

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from","title":"Inherited from","text":"

BaseIconProps.active

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#big","title":"big","text":"

\u2022 Optional big: boolean

A pre-defined icon-size

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_1","title":"Inherited from","text":"

BaseIconProps.big

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#data-testid","title":"data-testid","text":"

\u2022 Optional data-testid: string

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_2","title":"Inherited from","text":"

BaseIconProps.data-testid

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#disabled","title":"disabled","text":"

\u2022 Optional disabled: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_3","title":"Inherited from","text":"

BaseIconProps.disabled

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#focusable","title":"focusable","text":"

\u2022 Optional focusable: boolean

Allow focus to the icon to show .active styles. Only applicable if interactive is true.

Default

true\n
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_4","title":"Inherited from","text":"

BaseIconProps.focusable

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#href","title":"href","text":"

\u2022 Optional href: string

render icon as hyperlink

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_5","title":"Inherited from","text":"

BaseIconProps.href

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#interactive","title":"interactive","text":"

\u2022 Optional interactive: boolean

indicates that icon is interactive and highlight it on focus/hover

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_6","title":"Inherited from","text":"

BaseIconProps.interactive

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#link","title":"link","text":"

\u2022 Optional link: LocationDescriptor<unknown>

render icon as NavLink from react-router-dom

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_7","title":"Inherited from","text":"

BaseIconProps.link

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#material","title":"material","text":"

\u2022 Optional material: string

One of the names from https://material.io/icons/

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_8","title":"Inherited from","text":"

BaseIconProps.material

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#size","title":"size","text":"

\u2022 Optional size: string | number

The icon size (css units)

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_9","title":"Inherited from","text":"

BaseIconProps.size

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#small","title":"small","text":"

\u2022 Optional small: boolean

A pre-defined icon-size

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_10","title":"Inherited from","text":"

BaseIconProps.small

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#smallest","title":"smallest","text":"

\u2022 Optional smallest: boolean

A pre-defined icon-size

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_11","title":"Inherited from","text":"

BaseIconProps.smallest

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#sticker","title":"sticker","text":"

\u2022 Optional sticker: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_12","title":"Inherited from","text":"

BaseIconProps.sticker

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#svg","title":"svg","text":"

\u2022 Optional svg: string

Either an SVG XML or one of NamedSvg

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_13","title":"Inherited from","text":"

BaseIconProps.svg

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/","title":"Renderer.Component.KubeEventDetailsProps","text":"

@k8slens/extensions / Exports / Renderer / Component / KubeEventDetailsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/#interface-kubeeventdetailsprops","title":"Interface: KubeEventDetailsProps","text":"

Renderer.Component.KubeEventDetailsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/#properties","title":"Properties","text":"
  • object
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/#object","title":"object","text":"

\u2022 object: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/","title":"Renderer.Component.KubeObjectDetailsProps","text":"

@k8slens/extensions / Exports / Renderer / Component / KubeObjectDetailsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#interface-kubeobjectdetailspropskube","title":"Interface: KubeObjectDetailsProps<Kube>","text":"

Renderer.Component.KubeObjectDetailsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#type-parameters","title":"Type parameters","text":"Name Type Kube extends KubeObject = KubeObject"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#properties","title":"Properties","text":"
  • className
  • object
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#object","title":"object","text":"

\u2022 object: Kube

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/","title":"Renderer.Component.KubeObjectListLayoutProps","text":"

@k8slens/extensions / Exports / Renderer / Component / KubeObjectListLayoutProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#interface-kubeobjectlistlayoutpropsk-a-d","title":"Interface: KubeObjectListLayoutProps<K, A, D>","text":"

Renderer.Component.KubeObjectListLayoutProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#type-parameters","title":"Type parameters","text":"Name Type K extends KubeObject A extends KubeApi<K, D> D extends KubeJsonApiDataFor<K>"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#hierarchy","title":"Hierarchy","text":"
  • Omit<ItemListLayoutProps<K, false>, \"getItems\" | \"dependentStores\" | \"preloadStores\">

\u21b3 KubeObjectListLayoutProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#properties","title":"Properties","text":"
  • addRemoveButtons
  • className
  • columns
  • copyClassNameFromHeadCells
  • customizeHeader
  • customizeRemoveDialog
  • customizeTableRowProps
  • data-testid
  • dependentStores
  • detailsItem
  • failedToLoadMessage
  • filterCallbacks
  • filterItems
  • getItems
  • hasDetailsView
  • headerClassName
  • hideFilters
  • isConfigurable
  • isReady
  • isSelectable
  • items
  • onDetails
  • renderFooter
  • renderHeaderTitle
  • renderItemMenu
  • renderTableContents
  • renderTableHeader
  • resourceName
  • searchFilters
  • showHeader
  • sortingCallbacks
  • spinnerTestId
  • store
  • subscribeStores
  • tableId
  • tableProps
  • virtual
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#addremovebuttons","title":"addRemoveButtons","text":"

\u2022 Optional addRemoveButtons: Partial<AddRemoveButtonsProps>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from","title":"Inherited from","text":"

Omit.addRemoveButtons

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#classname","title":"className","text":"

\u2022 className: IClassName

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_1","title":"Inherited from","text":"

Omit.className

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#columns","title":"columns","text":"

\u2022 Optional columns: SpecificKubeListLayoutColumn<K>[]

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#copyclassnamefromheadcells","title":"copyClassNameFromHeadCells","text":"

\u2022 Optional copyClassNameFromHeadCells: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_2","title":"Inherited from","text":"

Omit.copyClassNameFromHeadCells

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#customizeheader","title":"customizeHeader","text":"

\u2022 Optional customizeHeader: HeaderCustomizer | HeaderCustomizer[]

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_3","title":"Inherited from","text":"

Omit.customizeHeader

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#customizeremovedialog","title":"customizeRemoveDialog","text":"

\u2022 Optional customizeRemoveDialog: (selectedItems: K[]) => Partial<ConfirmDialogParams>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#type-declaration","title":"Type declaration","text":"

\u25b8 (selectedItems): Partial<ConfirmDialogParams>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#parameters","title":"Parameters","text":"Name Type selectedItems K[]"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#returns","title":"Returns","text":"

Partial<ConfirmDialogParams>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_4","title":"Inherited from","text":"

Omit.customizeRemoveDialog

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#customizetablerowprops","title":"customizeTableRowProps","text":"

\u2022 Optional customizeTableRowProps: (item: K) => Partial<TableRowProps<K>>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (item): Partial<TableRowProps<K>>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#parameters_1","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#returns_1","title":"Returns","text":"

Partial<TableRowProps<K>>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_5","title":"Inherited from","text":"

Omit.customizeTableRowProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#data-testid","title":"data-testid","text":"

\u2022 Optional data-testid: string

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_6","title":"Inherited from","text":"

Omit.data-testid

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#dependentstores","title":"dependentStores","text":"

\u2022 Optional dependentStores: SubscribableStore[]

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#detailsitem","title":"detailsItem","text":"

\u2022 Optional detailsItem: K

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_7","title":"Inherited from","text":"

Omit.detailsItem

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#failedtoloadmessage","title":"failedToLoadMessage","text":"

\u2022 Optional failedToLoadMessage: ReactNode

Message to display when a store failed to load

Default

\"Failed to load items\"\n
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_8","title":"Inherited from","text":"

Omit.failedToLoadMessage

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#filtercallbacks","title":"filterCallbacks","text":"

\u2022 Optional filterCallbacks: ItemsFilters<K>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_9","title":"Inherited from","text":"

Omit.filterCallbacks

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#filteritems","title":"filterItems","text":"

\u2022 Optional filterItems: ItemsFilter<K>[]

Deprecated

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_10","title":"Inherited from","text":"

Omit.filterItems

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#getitems","title":"getItems","text":"

\u2022 Optional getItems: () => K[]

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (): K[]

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#returns_2","title":"Returns","text":"

K[]

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#hasdetailsview","title":"hasDetailsView","text":"

\u2022 Optional hasDetailsView: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_11","title":"Inherited from","text":"

Omit.hasDetailsView

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#headerclassname","title":"headerClassName","text":"

\u2022 Optional headerClassName: IClassName

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_12","title":"Inherited from","text":"

Omit.headerClassName

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#hidefilters","title":"hideFilters","text":"

\u2022 Optional hideFilters: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_13","title":"Inherited from","text":"

Omit.hideFilters

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#isconfigurable","title":"isConfigurable","text":"

\u2022 Optional isConfigurable: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_14","title":"Inherited from","text":"

Omit.isConfigurable

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#isready","title":"isReady","text":"

\u2022 Optional isReady: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_15","title":"Inherited from","text":"

Omit.isReady

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#isselectable","title":"isSelectable","text":"

\u2022 Optional isSelectable: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_16","title":"Inherited from","text":"

Omit.isSelectable

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#items","title":"items","text":"

\u2022 Optional items: K[]

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#ondetails","title":"onDetails","text":"

\u2022 Optional onDetails: (item: K) => void

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (item): void

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#parameters_2","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_17","title":"Inherited from","text":"

Omit.onDetails

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#renderfooter","title":"renderFooter","text":"

\u2022 Optional renderFooter: (parent: NonInjectedItemListLayout<K, false>) => ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (parent): ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#parameters_3","title":"Parameters","text":"Name Type parent NonInjectedItemListLayout<K, false>"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#returns_4","title":"Returns","text":"

ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_18","title":"Inherited from","text":"

Omit.renderFooter

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#renderheadertitle","title":"renderHeaderTitle","text":"

\u2022 Optional renderHeaderTitle: RenderHeaderTitle<K, false>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_19","title":"Inherited from","text":"

Omit.renderHeaderTitle

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#renderitemmenu","title":"renderItemMenu","text":"

\u2022 Optional renderItemMenu: (item: K, store: ItemListStore<K, false>) => ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item, store): ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#parameters_4","title":"Parameters","text":"Name Type item K store ItemListStore<K, false>"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#returns_5","title":"Returns","text":"

ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_20","title":"Inherited from","text":"

Omit.renderItemMenu

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#rendertablecontents","title":"renderTableContents","text":"

\u2022 renderTableContents: (item: K) => (ReactNode | TableCellProps)[]

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (item): (ReactNode | TableCellProps)[]

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#parameters_5","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#returns_6","title":"Returns","text":"

(ReactNode | TableCellProps)[]

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_21","title":"Inherited from","text":"

Omit.renderTableContents

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#rendertableheader","title":"renderTableHeader","text":"

\u2022 Optional renderTableHeader: (undefined | null | TableCellProps)[]

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_22","title":"Inherited from","text":"

Omit.renderTableHeader

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#resourcename","title":"resourceName","text":"

\u2022 Optional resourceName: string

Customize resource name for e.g. search input (\"Search ...\"\") If not provided, ResourceNames is used instead with a fallback to resource kind."},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#searchfilters","title":"searchFilters","text":"

\u2022 Optional searchFilters: SearchFilter<K>[]

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_23","title":"Inherited from","text":"

Omit.searchFilters

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#showheader","title":"showHeader","text":"

\u2022 Optional showHeader: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_24","title":"Inherited from","text":"

Omit.showHeader

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#sortingcallbacks","title":"sortingCallbacks","text":"

\u2022 Optional sortingCallbacks: TableSortCallbacks<K>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_25","title":"Inherited from","text":"

Omit.sortingCallbacks

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#spinnertestid","title":"spinnerTestId","text":"

\u2022 Optional spinnerTestId: string

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_26","title":"Inherited from","text":"

Omit.spinnerTestId

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#store","title":"store","text":"

\u2022 store: KubeItemListStore<K>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#overrides","title":"Overrides","text":"

Omit.store

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#subscribestores","title":"subscribeStores","text":"

\u2022 Optional subscribeStores: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#tableid","title":"tableId","text":"

\u2022 Optional tableId: string

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_27","title":"Inherited from","text":"

Omit.tableId

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#tableprops","title":"tableProps","text":"

\u2022 Optional tableProps: Partial<TableProps<K>>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_28","title":"Inherited from","text":"

Omit.tableProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#virtual","title":"virtual","text":"

\u2022 Optional virtual: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_29","title":"Inherited from","text":"

Omit.virtual

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/","title":"Renderer.Component.KubeObjectMenuProps","text":"

@k8slens/extensions / Exports / Renderer / Component / KubeObjectMenuProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#interface-kubeobjectmenupropstkubeobject","title":"Interface: KubeObjectMenuProps<TKubeObject>","text":"

Renderer.Component.KubeObjectMenuProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#type-parameters","title":"Type parameters","text":"Name Type TKubeObject extends KubeObject"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#hierarchy","title":"Hierarchy","text":"
  • MenuActionsProps

\u21b3 KubeObjectMenuProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#properties","title":"Properties","text":"
  • animated
  • autoCloseOnSelect
  • autoFocus
  • children
  • className
  • closeOnClickItem
  • closeOnClickOutside
  • closeOnScroll
  • data-testid
  • editable
  • htmlFor
  • id
  • isOpen
  • object
  • onOpen
  • position
  • removable
  • removeAction
  • removeConfirmationMessage
  • toggleEvent
  • toolbar
  • triggerIcon
  • updateAction
  • usePortal
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#methods","title":"Methods","text":"
  • close
  • open
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#animated","title":"animated","text":"

\u2022 Optional animated: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from","title":"Inherited from","text":"

MenuActionsProps.animated

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#autocloseonselect","title":"autoCloseOnSelect","text":"

\u2022 Optional autoCloseOnSelect: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_1","title":"Inherited from","text":"

MenuActionsProps.autoCloseOnSelect

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#autofocus","title":"autoFocus","text":"

\u2022 Optional autoFocus: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_2","title":"Inherited from","text":"

MenuActionsProps.autoFocus

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#children","title":"children","text":"

\u2022 Optional children: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_3","title":"Inherited from","text":"

MenuActionsProps.children

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_4","title":"Inherited from","text":"

MenuActionsProps.className

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#closeonclickitem","title":"closeOnClickItem","text":"

\u2022 Optional closeOnClickItem: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_5","title":"Inherited from","text":"

MenuActionsProps.closeOnClickItem

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#closeonclickoutside","title":"closeOnClickOutside","text":"

\u2022 Optional closeOnClickOutside: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_6","title":"Inherited from","text":"

MenuActionsProps.closeOnClickOutside

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#closeonscroll","title":"closeOnScroll","text":"

\u2022 Optional closeOnScroll: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_7","title":"Inherited from","text":"

MenuActionsProps.closeOnScroll

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#data-testid","title":"data-testid","text":"

\u2022 Optional data-testid: string

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_8","title":"Inherited from","text":"

MenuActionsProps.data-testid

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#editable","title":"editable","text":"

\u2022 Optional editable: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#htmlfor","title":"htmlFor","text":"

\u2022 Optional htmlFor: string

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_9","title":"Inherited from","text":"

MenuActionsProps.htmlFor

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#id","title":"id","text":"

\u2022 Optional id: string

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_10","title":"Inherited from","text":"

MenuActionsProps.id

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#isopen","title":"isOpen","text":"

\u2022 Optional isOpen: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_11","title":"Inherited from","text":"

MenuActionsProps.isOpen

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#object","title":"object","text":"

\u2022 object: TKubeObject

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#onopen","title":"onOpen","text":"

\u2022 Optional onOpen: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#type-declaration","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_12","title":"Inherited from","text":"

MenuActionsProps.onOpen

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#position","title":"position","text":"

\u2022 Optional position: MenuPosition

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_13","title":"Inherited from","text":"

MenuActionsProps.position

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#removable","title":"removable","text":"

\u2022 Optional removable: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#removeaction","title":"removeAction","text":"

\u2022 Optional removeAction: () => void | Promise<void>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (): void | Promise<void>

Deprecated

Provide your own remove <MenuItem> as part of the children passed to this component

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#returns_1","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_14","title":"Inherited from","text":"

MenuActionsProps.removeAction

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#removeconfirmationmessage","title":"removeConfirmationMessage","text":"

\u2022 Optional removeConfirmationMessage: ReactNode | () => ReactNode

Deprecated

Provide your own remove <MenuItem> as part of the children passed to this component

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_15","title":"Inherited from","text":"

MenuActionsProps.removeConfirmationMessage

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#toggleevent","title":"toggleEvent","text":"

\u2022 Optional toggleEvent: \"click\" | \"contextmenu\"

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_16","title":"Inherited from","text":"

MenuActionsProps.toggleEvent

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#toolbar","title":"toolbar","text":"

\u2022 Optional toolbar: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_17","title":"Inherited from","text":"

MenuActionsProps.toolbar

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#triggericon","title":"triggerIcon","text":"

\u2022 Optional triggerIcon: ReactNode | IconProps & TooltipDecoratorProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_18","title":"Inherited from","text":"

MenuActionsProps.triggerIcon

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#updateaction","title":"updateAction","text":"

\u2022 Optional updateAction: () => void | Promise<void>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (): void | Promise<void>

Deprecated

Provide your own update <MenuItem> as part of the children passed to this component

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#returns_2","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_19","title":"Inherited from","text":"

MenuActionsProps.updateAction

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#useportal","title":"usePortal","text":"

\u2022 Optional usePortal: boolean | HTMLElement

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_20","title":"Inherited from","text":"

MenuActionsProps.usePortal

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#close","title":"close","text":"

\u25b8 Optional close(): void

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_21","title":"Inherited from","text":"

MenuActionsProps.close

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#open","title":"open","text":"

\u25b8 Optional open(): void

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#returns_4","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_22","title":"Inherited from","text":"

MenuActionsProps.open

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/","title":"Renderer.Component.KubeObjectMetaProps","text":"

@k8slens/extensions / Exports / Renderer / Component / KubeObjectMetaProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/#interface-kubeobjectmetaprops","title":"Interface: KubeObjectMetaProps","text":"

Renderer.Component.KubeObjectMetaProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/#properties","title":"Properties","text":"
  • hideFields
  • object
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/#hidefields","title":"hideFields","text":"

\u2022 Optional hideFields: keyof BaseKubeJsonApiObjectMetadata<KubeObjectScope>[]

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/#object","title":"object","text":"

\u2022 object: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/","title":"Renderer.Component.LineProgressProps","text":"

@k8slens/extensions / Exports / Renderer / Component / LineProgressProps

"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#interface-lineprogressprops","title":"Interface: LineProgressProps","text":"

Renderer.Component.LineProgressProps

"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#hierarchy","title":"Hierarchy","text":"
  • HTMLProps<HTMLDivElement>

\u21b3 LineProgressProps

"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#properties","title":"Properties","text":"
  • className
  • max
  • min
  • precise
  • value
"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#classname","title":"className","text":"

\u2022 Optional className: any

"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#overrides","title":"Overrides","text":"

React.HTMLProps.className

"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#max","title":"max","text":"

\u2022 Optional max: number

"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#overrides_1","title":"Overrides","text":"

React.HTMLProps.max

"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#min","title":"min","text":"

\u2022 Optional min: number

"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#overrides_2","title":"Overrides","text":"

React.HTMLProps.min

"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#precise","title":"precise","text":"

\u2022 Optional precise: number

"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#value","title":"value","text":"

\u2022 value: number

"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#overrides_3","title":"Overrides","text":"

React.HTMLProps.value

"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/","title":"Renderer.Component.MainLayoutProps","text":"

@k8slens/extensions / Exports / Renderer / Component / MainLayoutProps

"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#interface-mainlayoutprops","title":"Interface: MainLayoutProps","text":"

Renderer.Component.MainLayoutProps

"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#properties","title":"Properties","text":"
  • children
  • className
  • footer
  • sidebar
"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#children","title":"children","text":"

\u2022 Optional children: ReactNode | ReactNode[]

"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#footer","title":"footer","text":"

\u2022 Optional footer: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#sidebar","title":"sidebar","text":"

\u2022 sidebar: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/","title":"Renderer.Component.MenuActionsProps","text":"

@k8slens/extensions / Exports / Renderer / Component / MenuActionsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#interface-menuactionsprops","title":"Interface: MenuActionsProps","text":"

Renderer.Component.MenuActionsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#hierarchy","title":"Hierarchy","text":"
  • Partial<MenuProps>

\u21b3 MenuActionsProps

\u21b3\u21b3 KubeObjectMenuProps

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#properties","title":"Properties","text":"
  • animated
  • autoCloseOnSelect
  • autoFocus
  • children
  • className
  • closeOnClickItem
  • closeOnClickOutside
  • closeOnScroll
  • data-testid
  • htmlFor
  • id
  • isOpen
  • onOpen
  • position
  • removeAction
  • removeConfirmationMessage
  • toggleEvent
  • toolbar
  • triggerIcon
  • updateAction
  • usePortal
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#methods","title":"Methods","text":"
  • close
  • open
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#animated","title":"animated","text":"

\u2022 Optional animated: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#inherited-from","title":"Inherited from","text":"

Partial.animated

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#autocloseonselect","title":"autoCloseOnSelect","text":"

\u2022 Optional autoCloseOnSelect: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#autofocus","title":"autoFocus","text":"

\u2022 Optional autoFocus: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#inherited-from_1","title":"Inherited from","text":"

Partial.autoFocus

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#children","title":"children","text":"

\u2022 Optional children: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#inherited-from_2","title":"Inherited from","text":"

Partial.children

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#overrides","title":"Overrides","text":"

Partial.className

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#closeonclickitem","title":"closeOnClickItem","text":"

\u2022 Optional closeOnClickItem: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#inherited-from_3","title":"Inherited from","text":"

Partial.closeOnClickItem

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#closeonclickoutside","title":"closeOnClickOutside","text":"

\u2022 Optional closeOnClickOutside: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#inherited-from_4","title":"Inherited from","text":"

Partial.closeOnClickOutside

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#closeonscroll","title":"closeOnScroll","text":"

\u2022 Optional closeOnScroll: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#inherited-from_5","title":"Inherited from","text":"

Partial.closeOnScroll

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#data-testid","title":"data-testid","text":"

\u2022 Optional data-testid: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#inherited-from_6","title":"Inherited from","text":"

Partial.data-testid

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#htmlfor","title":"htmlFor","text":"

\u2022 Optional htmlFor: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#inherited-from_7","title":"Inherited from","text":"

Partial.htmlFor

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#id","title":"id","text":"

\u2022 Optional id: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#overrides_1","title":"Overrides","text":"

Partial.id

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#isopen","title":"isOpen","text":"

\u2022 Optional isOpen: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#inherited-from_8","title":"Inherited from","text":"

Partial.isOpen

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#onopen","title":"onOpen","text":"

\u2022 Optional onOpen: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#type-declaration","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#position","title":"position","text":"

\u2022 Optional position: MenuPosition

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#inherited-from_9","title":"Inherited from","text":"

Partial.position

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#removeaction","title":"removeAction","text":"

\u2022 Optional removeAction: () => void | Promise<void>

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (): void | Promise<void>

Deprecated

Provide your own remove <MenuItem> as part of the children passed to this component

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#returns_1","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#removeconfirmationmessage","title":"removeConfirmationMessage","text":"

\u2022 Optional removeConfirmationMessage: ReactNode | () => ReactNode

Deprecated

Provide your own remove <MenuItem> as part of the children passed to this component

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#toggleevent","title":"toggleEvent","text":"

\u2022 Optional toggleEvent: \"click\" | \"contextmenu\"

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#inherited-from_10","title":"Inherited from","text":"

Partial.toggleEvent

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#toolbar","title":"toolbar","text":"

\u2022 Optional toolbar: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#triggericon","title":"triggerIcon","text":"

\u2022 Optional triggerIcon: ReactNode | IconProps & TooltipDecoratorProps

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#updateaction","title":"updateAction","text":"

\u2022 Optional updateAction: () => void | Promise<void>

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (): void | Promise<void>

Deprecated

Provide your own update <MenuItem> as part of the children passed to this component

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#returns_2","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#useportal","title":"usePortal","text":"

\u2022 Optional usePortal: boolean | HTMLElement

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#inherited-from_11","title":"Inherited from","text":"

Partial.usePortal

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#close","title":"close","text":"

\u25b8 Optional close(): void

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#inherited-from_12","title":"Inherited from","text":"

Partial.close

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#open","title":"open","text":"

\u25b8 Optional open(): void

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#returns_4","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#inherited-from_13","title":"Inherited from","text":"

Partial.open

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/","title":"Renderer.Component.MenuContextValue","text":"

@k8slens/extensions / Exports / Renderer / Component / MenuContextValue

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#interface-menucontextvalue","title":"Interface: MenuContextValue","text":"

Renderer.Component.MenuContextValue

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#properties","title":"Properties","text":"
  • close
  • props
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#close","title":"close","text":"

\u2022 close: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#type-declaration","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#props","title":"props","text":"

\u2022 Readonly props: Readonly<MenuProps>

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/","title":"Renderer.Component.MenuItemProps","text":"

@k8slens/extensions / Exports / Renderer / Component / MenuItemProps

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#interface-menuitemprops","title":"Interface: MenuItemProps","text":"

Renderer.Component.MenuItemProps

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#hierarchy","title":"Hierarchy","text":"
  • HTMLProps<any>

\u21b3 MenuItemProps

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#properties","title":"Properties","text":"
  • active
  • disabled
  • href
  • icon
  • spacer
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#active","title":"active","text":"

\u2022 Optional active: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#disabled","title":"disabled","text":"

\u2022 Optional disabled: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#overrides","title":"Overrides","text":"

React.HTMLProps.disabled

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#href","title":"href","text":"

\u2022 Optional href: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#overrides_1","title":"Overrides","text":"

React.HTMLProps.href

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#icon","title":"icon","text":"

\u2022 Optional icon: string | Partial<IconProps>

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#spacer","title":"spacer","text":"

\u2022 Optional spacer: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/","title":"Renderer.Component.MenuPosition","text":"

@k8slens/extensions / Exports / Renderer / Component / MenuPosition

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#interface-menuposition","title":"Interface: MenuPosition","text":"

Renderer.Component.MenuPosition

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#properties","title":"Properties","text":"
  • bottom
  • left
  • right
  • top
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#bottom","title":"bottom","text":"

\u2022 Optional bottom: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#left","title":"left","text":"

\u2022 Optional left: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#right","title":"right","text":"

\u2022 Optional right: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#top","title":"top","text":"

\u2022 Optional top: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/","title":"Renderer.Component.MenuProps","text":"

@k8slens/extensions / Exports / Renderer / Component / MenuProps

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#interface-menuprops","title":"Interface: MenuProps","text":"

Renderer.Component.MenuProps

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#properties","title":"Properties","text":"
  • animated
  • autoFocus
  • children
  • className
  • closeOnClickItem
  • closeOnClickOutside
  • closeOnScroll
  • data-testid
  • htmlFor
  • id
  • isOpen
  • position
  • toggleEvent
  • usePortal
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#methods","title":"Methods","text":"
  • close
  • open
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#animated","title":"animated","text":"

\u2022 Optional animated: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#autofocus","title":"autoFocus","text":"

\u2022 Optional autoFocus: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#children","title":"children","text":"

\u2022 Optional children: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#closeonclickitem","title":"closeOnClickItem","text":"

\u2022 Optional closeOnClickItem: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#closeonclickoutside","title":"closeOnClickOutside","text":"

\u2022 Optional closeOnClickOutside: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#closeonscroll","title":"closeOnScroll","text":"

\u2022 Optional closeOnScroll: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#data-testid","title":"data-testid","text":"

\u2022 Optional data-testid: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#htmlfor","title":"htmlFor","text":"

\u2022 Optional htmlFor: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#id","title":"id","text":"

\u2022 Optional id: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#isopen","title":"isOpen","text":"

\u2022 Optional isOpen: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#position","title":"position","text":"

\u2022 Optional position: MenuPosition

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#toggleevent","title":"toggleEvent","text":"

\u2022 Optional toggleEvent: \"click\" | \"contextmenu\"

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#useportal","title":"usePortal","text":"

\u2022 Optional usePortal: boolean | HTMLElement

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#close","title":"close","text":"

\u25b8 close(): void

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#open","title":"open","text":"

\u25b8 open(): void

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/","title":"Renderer.Component.MenuStyle","text":"

@k8slens/extensions / Exports / Renderer / Component / MenuStyle

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/#interface-menustyle","title":"Interface: MenuStyle","text":"

Renderer.Component.MenuStyle

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/#properties","title":"Properties","text":"
  • left
  • top
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/#left","title":"left","text":"

\u2022 left: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/#top","title":"top","text":"

\u2022 top: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/","title":"Renderer.Component.MonacoEditorProps","text":"

@k8slens/extensions / Exports / Renderer / Component / MonacoEditorProps

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#interface-monacoeditorprops","title":"Interface: MonacoEditorProps","text":"

Renderer.Component.MonacoEditorProps

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#properties","title":"Properties","text":"
  • autoFocus
  • className
  • id
  • innerRef
  • language
  • options
  • readOnly
  • setInitialHeight
  • style
  • theme
  • value
"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#methods","title":"Methods","text":"
  • onChange
  • onDidContentSizeChange
  • onDidLayoutChange
  • onError
  • onModelChange
"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#autofocus","title":"autoFocus","text":"

\u2022 Optional autoFocus: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#id","title":"id","text":"

\u2022 Optional id: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#innerref","title":"innerRef","text":"

\u2022 Optional innerRef: ForwardedRef<MonacoEditorRef>

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#language","title":"language","text":"

\u2022 Optional language: \"yaml\" | \"json\"

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#options","title":"options","text":"

\u2022 Optional options: Partial<IStandaloneEditorConstructionOptions>

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#readonly","title":"readOnly","text":"

\u2022 Optional readOnly: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#setinitialheight","title":"setInitialHeight","text":"

\u2022 Optional setInitialHeight: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#style","title":"style","text":"

\u2022 Optional style: CSSProperties

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#theme","title":"theme","text":"

\u2022 Optional theme: MonacoTheme

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#value","title":"value","text":"

\u2022 value: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#onchange","title":"onChange","text":"

\u25b8 Optional onChange(value, evt): void

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#parameters","title":"Parameters","text":"Name Type value string evt IModelContentChangedEvent"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#ondidcontentsizechange","title":"onDidContentSizeChange","text":"

\u25b8 Optional onDidContentSizeChange(evt): void

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#parameters_1","title":"Parameters","text":"Name Type evt IContentSizeChangedEvent"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#ondidlayoutchange","title":"onDidLayoutChange","text":"

\u25b8 Optional onDidLayoutChange(info): void

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#parameters_2","title":"Parameters","text":"Name Type info EditorLayoutInfo"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#onerror","title":"onError","text":"

\u25b8 Optional onError(error): void

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#parameters_3","title":"Parameters","text":"Name Type error unknown"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#onmodelchange","title":"onModelChange","text":"

\u25b8 Optional onModelChange(model, prev?): void

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#parameters_4","title":"Parameters","text":"Name Type model ITextModel prev? ITextModel"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#returns_4","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/","title":"Renderer.Component.NamespaceSelectProps","text":"

@k8slens/extensions / Exports / Renderer / Component / NamespaceSelectProps

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#interface-namespaceselectpropsismulti","title":"Interface: NamespaceSelectProps<IsMulti>","text":"

Renderer.Component.NamespaceSelectProps

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#type-parameters","title":"Type parameters","text":"Name Type IsMulti extends boolean"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#hierarchy","title":"Hierarchy","text":"
  • Omit<SelectProps<string, { label: string ; value: string }, IsMulti>, \"options\" | \"value\">

\u21b3 NamespaceSelectProps

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#properties","title":"Properties","text":"
  • autoConvertOptions
  • id
  • isCreatable
  • menuClass
  • showIcons
  • sort
  • themeName
  • value
"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#autoconvertoptions","title":"autoConvertOptions","text":"

\u2022 Optional autoConvertOptions: boolean

Deprecated

We will always auto convert options if they are of type string

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#inherited-from","title":"Inherited from","text":"

Omit.autoConvertOptions

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#id","title":"id","text":"

\u2022 Optional id: string

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#inherited-from_1","title":"Inherited from","text":"

Omit.id

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#iscreatable","title":"isCreatable","text":"

\u2022 Optional isCreatable: boolean

Deprecated

This option does nothing

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#inherited-from_2","title":"Inherited from","text":"

Omit.isCreatable

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#menuclass","title":"menuClass","text":"

\u2022 Optional menuClass: string

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#inherited-from_3","title":"Inherited from","text":"

Omit.menuClass

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#showicons","title":"showIcons","text":"

\u2022 Optional showIcons: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#sort","title":"sort","text":"

\u2022 Optional sort: NamespaceSelectSort

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#themename","title":"themeName","text":"

\u2022 Optional themeName: \"dark\" | \"light\" | \"outlined\" | \"lens\"

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#inherited-from_4","title":"Inherited from","text":"

Omit.themeName

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#value","title":"value","text":"

\u2022 value: undefined | null | string

"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/","title":"Renderer.Component.Notification","text":"

@k8slens/extensions / Exports / Renderer / Component / Notification

"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#interface-notification","title":"Interface: Notification","text":"

Renderer.Component.Notification

"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#properties","title":"Properties","text":"
  • id
  • message
  • status
  • timeout
"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#methods","title":"Methods","text":"
  • onClose
"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#id","title":"id","text":"

\u2022 Optional id: NotificationId

"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#message","title":"message","text":"

\u2022 message: NotificationMessage

"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#status","title":"status","text":"

\u2022 Optional status: NotificationStatus

"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#timeout","title":"timeout","text":"

\u2022 Optional timeout: number

"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#onclose","title":"onClose","text":"

\u25b8 Optional onClose(): void

"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/","title":"Renderer.Component.PieChartData","text":"

@k8slens/extensions / Exports / Renderer / Component / PieChartData

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/#interface-piechartdata","title":"Interface: PieChartData","text":"

Renderer.Component.PieChartData

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/#hierarchy","title":"Hierarchy","text":"
  • ChartData

\u21b3 PieChartData

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/#properties","title":"Properties","text":"
  • datasets
"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/#datasets","title":"datasets","text":"

\u2022 Optional datasets: PieChartDataSets[]

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/#overrides","title":"Overrides","text":"

ChartJS.ChartData.datasets

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/","title":"Renderer.Component.PieChartProps","text":"

@k8slens/extensions / Exports / Renderer / Component / PieChartProps

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#interface-piechartprops","title":"Interface: PieChartProps","text":"

Renderer.Component.PieChartProps

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#hierarchy","title":"Hierarchy","text":"
  • ChartProps

\u21b3 PieChartProps

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#properties","title":"Properties","text":"
  • className
  • data
  • data-testid
  • height
  • legendColors
  • legendPosition
  • options
  • plugins
  • redraw
  • showChart
  • showLegend
  • title
  • type
  • width
"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#inherited-from","title":"Inherited from","text":"

ChartProps.className

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#data","title":"data","text":"

\u2022 data: ChartData

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#inherited-from_1","title":"Inherited from","text":"

ChartProps.data

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#data-testid","title":"data-testid","text":"

\u2022 Optional data-testid: string

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#inherited-from_2","title":"Inherited from","text":"

ChartProps.data-testid

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#height","title":"height","text":"

\u2022 Optional height: string | number

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#inherited-from_3","title":"Inherited from","text":"

ChartProps.height

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#legendcolors","title":"legendColors","text":"

\u2022 Optional legendColors: string[]

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#inherited-from_4","title":"Inherited from","text":"

ChartProps.legendColors

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#legendposition","title":"legendPosition","text":"

\u2022 Optional legendPosition: \"bottom\"

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#inherited-from_5","title":"Inherited from","text":"

ChartProps.legendPosition

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#options","title":"options","text":"

\u2022 Optional options: ChartOptions

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#inherited-from_6","title":"Inherited from","text":"

ChartProps.options

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#plugins","title":"plugins","text":"

\u2022 Optional plugins: PluginServiceRegistrationOptions[]

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#inherited-from_7","title":"Inherited from","text":"

ChartProps.plugins

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#redraw","title":"redraw","text":"

\u2022 Optional redraw: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#inherited-from_8","title":"Inherited from","text":"

ChartProps.redraw

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#showchart","title":"showChart","text":"

\u2022 Optional showChart: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#inherited-from_9","title":"Inherited from","text":"

ChartProps.showChart

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#showlegend","title":"showLegend","text":"

\u2022 Optional showLegend: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#inherited-from_10","title":"Inherited from","text":"

ChartProps.showLegend

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#title","title":"title","text":"

\u2022 Optional title: string

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#inherited-from_11","title":"Inherited from","text":"

ChartProps.title

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#type","title":"type","text":"

\u2022 Optional type: ChartKind

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#inherited-from_12","title":"Inherited from","text":"

ChartProps.type

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#width","title":"width","text":"

\u2022 Optional width: string | number

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#inherited-from_13","title":"Inherited from","text":"

ChartProps.width

"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/","title":"Renderer.Component.PodDetailsListProps","text":"

@k8slens/extensions / Exports / Renderer / Component / PodDetailsListProps

"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#interface-poddetailslistprops","title":"Interface: PodDetailsListProps","text":"

Renderer.Component.PodDetailsListProps

"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#properties","title":"Properties","text":"
  • maxCpu
  • maxMemory
  • owner
  • pods
"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#maxcpu","title":"maxCpu","text":"

\u2022 Optional maxCpu: number

"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#maxmemory","title":"maxMemory","text":"

\u2022 Optional maxMemory: number

"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#owner","title":"owner","text":"

\u2022 owner: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#pods","title":"pods","text":"

\u2022 pods: Pod[]

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/","title":"Renderer.Component.RadioGroupProps","text":"

@k8slens/extensions / Exports / Renderer / Component / RadioGroupProps

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#interface-radiogrouppropst","title":"Interface: RadioGroupProps<T>","text":"

Renderer.Component.RadioGroupProps

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#type-parameters","title":"Type parameters","text":"Name T"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#properties","title":"Properties","text":"
  • asButtons
  • children
  • className
  • disabled
  • onChange
  • value
"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#asbuttons","title":"asButtons","text":"

\u2022 Optional asButtons: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#children","title":"children","text":"

\u2022 children: SingleOrMany<ReactElement<RadioProps<T>, string | JSXElementConstructor<any>>>

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#disabled","title":"disabled","text":"

\u2022 Optional disabled: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#onchange","title":"onChange","text":"

\u2022 onChange: (value: T) => void

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#type-declaration","title":"Type declaration","text":"

\u25b8 (value): void

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#parameters","title":"Parameters","text":"Name Type value T"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#value","title":"value","text":"

\u2022 Optional value: T

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/","title":"Renderer.Component.RadioProps","text":"

@k8slens/extensions / Exports / Renderer / Component / RadioProps

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#interface-radiopropst","title":"Interface: RadioProps<T>","text":"

Renderer.Component.RadioProps

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#type-parameters","title":"Type parameters","text":"Name T"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#properties","title":"Properties","text":"
  • className
  • disabled
  • label
  • value
"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#disabled","title":"disabled","text":"

\u2022 Optional disabled: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#label","title":"label","text":"

\u2022 label: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#value","title":"value","text":"

\u2022 value: T

"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/","title":"Renderer.Component.ResourceMetricsProps","text":"

@k8slens/extensions / Exports / Renderer / Component / ResourceMetricsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/#interface-resourcemetricspropskeys","title":"Interface: ResourceMetricsProps<Keys>","text":"

Renderer.Component.ResourceMetricsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/#type-parameters","title":"Type parameters","text":"Name Type Keys extends string"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/#properties","title":"Properties","text":"
  • children
  • className
  • metrics
  • object
  • tabs
"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/#children","title":"children","text":"

\u2022 children: ReactChild | ReactChild[]

"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/#metrics","title":"metrics","text":"

\u2022 metrics: Partial<Record<Keys, MetricData>> | IAsyncComputed<undefined | null | Partial<Record<Keys, MetricData>>>

"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/#object","title":"object","text":"

\u2022 object: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/#tabs","title":"tabs","text":"

\u2022 tabs: AtLeastOneMetricTab

"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsValue/","title":"Renderer.Component.ResourceMetricsValue","text":"

@k8slens/extensions / Exports / Renderer / Component / ResourceMetricsValue

"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsValue/#interface-resourcemetricsvalue","title":"Interface: ResourceMetricsValue","text":"

Renderer.Component.ResourceMetricsValue

"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsValue/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsValue/#properties","title":"Properties","text":"
  • metrics
  • object
  • tab
"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsValue/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsValue/#metrics","title":"metrics","text":"

\u2022 metrics: undefined | null | Partial<Record<string, MetricData>>

"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsValue/#object","title":"object","text":"

\u2022 object: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsValue/#tab","title":"tab","text":"

\u2022 tab: MetricsTab

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/","title":"Renderer.Component.SearchInputProps","text":"

@k8slens/extensions / Exports / Renderer / Component / SearchInputProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#interface-searchinputprops","title":"Interface: SearchInputProps","text":"

Renderer.Component.SearchInputProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#hierarchy","title":"Hierarchy","text":"
  • InputProps

\u21b3 SearchInputProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#properties","title":"Properties","text":"
  • autoSelectOnFocus
  • bindGlobalFocusHotkey
  • blurOnEnter
  • compact
  • contentRight
  • dirty
  • iconLeft
  • iconRight
  • maxRows
  • multiLine
  • showClearIcon
  • showErrorsAsTooltip
  • showValidationLine
  • theme
  • trim
  • validators
"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#methods","title":"Methods","text":"
  • onChange
  • onClear
  • onSubmit
"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#autoselectonfocus","title":"autoSelectOnFocus","text":"

\u2022 Optional autoSelectOnFocus: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from","title":"Inherited from","text":"

InputProps.autoSelectOnFocus

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#bindglobalfocushotkey","title":"bindGlobalFocusHotkey","text":"

\u2022 Optional bindGlobalFocusHotkey: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#bluronenter","title":"blurOnEnter","text":"

\u2022 Optional blurOnEnter: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from_1","title":"Inherited from","text":"

InputProps.blurOnEnter

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#compact","title":"compact","text":"

\u2022 Optional compact: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#contentright","title":"contentRight","text":"

\u2022 Optional contentRight: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from_2","title":"Inherited from","text":"

InputProps.contentRight

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#dirty","title":"dirty","text":"

\u2022 Optional dirty: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from_3","title":"Inherited from","text":"

InputProps.dirty

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#iconleft","title":"iconLeft","text":"

\u2022 Optional iconLeft: IconData

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from_4","title":"Inherited from","text":"

InputProps.iconLeft

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#iconright","title":"iconRight","text":"

\u2022 Optional iconRight: IconData

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from_5","title":"Inherited from","text":"

InputProps.iconRight

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#maxrows","title":"maxRows","text":"

\u2022 Optional maxRows: number

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from_6","title":"Inherited from","text":"

InputProps.maxRows

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#multiline","title":"multiLine","text":"

\u2022 Optional multiLine: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from_7","title":"Inherited from","text":"

InputProps.multiLine

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#showclearicon","title":"showClearIcon","text":"

\u2022 Optional showClearIcon: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#showerrorsastooltip","title":"showErrorsAsTooltip","text":"

\u2022 Optional showErrorsAsTooltip: boolean | Omit<TooltipProps, \"targetId\">

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from_8","title":"Inherited from","text":"

InputProps.showErrorsAsTooltip

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#showvalidationline","title":"showValidationLine","text":"

\u2022 Optional showValidationLine: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from_9","title":"Inherited from","text":"

InputProps.showValidationLine

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#theme","title":"theme","text":"

\u2022 Optional theme: \"round-black\" | \"round\"

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from_10","title":"Inherited from","text":"

InputProps.theme

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#trim","title":"trim","text":"

\u2022 Optional trim: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from_11","title":"Inherited from","text":"

InputProps.trim

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#validators","title":"validators","text":"

\u2022 Optional validators: SingleOrMany<InputValidator<boolean>>

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from_12","title":"Inherited from","text":"

InputProps.validators

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#onchange","title":"onChange","text":"

\u25b8 Optional onChange(value, evt): void

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#parameters","title":"Parameters","text":"Name Type value string evt ChangeEvent<InputElement>"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from_13","title":"Inherited from","text":"

InputProps.onChange

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#onclear","title":"onClear","text":"

\u25b8 Optional onClear(): void

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#onsubmit","title":"onSubmit","text":"

\u25b8 Optional onSubmit(value, evt): void

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#parameters_1","title":"Parameters","text":"Name Type value string evt KeyboardEvent<InputElement>"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from_14","title":"Inherited from","text":"

InputProps.onSubmit

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/","title":"Renderer.Component.SelectOption","text":"

@k8slens/extensions / Exports / Renderer / Component / SelectOption

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#interface-selectoptionvalue","title":"Interface: SelectOption<Value>","text":"

Renderer.Component.SelectOption

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#type-parameters","title":"Type parameters","text":"Name Value"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#properties","title":"Properties","text":"
  • id
  • isDisabled
  • isSelected
  • label
  • value
"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#id","title":"id","text":"

\u2022 Optional id: string

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#isdisabled","title":"isDisabled","text":"

\u2022 Optional isDisabled: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#isselected","title":"isSelected","text":"

\u2022 Optional isSelected: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#label","title":"label","text":"

\u2022 label: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#value","title":"value","text":"

\u2022 value: Value

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/","title":"Renderer.Component.SelectProps","text":"

@k8slens/extensions / Exports / Renderer / Component / SelectProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#interface-selectpropsvalue-option-ismulti-group","title":"Interface: SelectProps<Value, Option, IsMulti, Group>","text":"

Renderer.Component.SelectProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#type-parameters","title":"Type parameters","text":"Name Type Value Value Option extends SelectOption<Value> IsMulti extends boolean Group extends GroupBase<Option> = GroupBase<Option>"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#hierarchy","title":"Hierarchy","text":"
  • Omit<ReactSelectProps<Option, IsMulti, Group>, \"value\" | \"options\">

\u21b3 SelectProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#properties","title":"Properties","text":"
  • autoConvertOptions
  • id
  • isCreatable
  • menuClass
  • options
  • themeName
  • value
"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#autoconvertoptions","title":"autoConvertOptions","text":"

\u2022 Optional autoConvertOptions: boolean

Deprecated

We will always auto convert options if they are of type string

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#id","title":"id","text":"

\u2022 Optional id: string

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#overrides","title":"Overrides","text":"

Omit.id

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#iscreatable","title":"isCreatable","text":"

\u2022 Optional isCreatable: boolean

Deprecated

This option does nothing

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#menuclass","title":"menuClass","text":"

\u2022 Optional menuClass: string

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#options","title":"options","text":"

\u2022 options: OptionsOrGroups<Option, Group> | LegacyAutoConvertedOptions

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#themename","title":"themeName","text":"

\u2022 Optional themeName: \"dark\" | \"light\" | \"outlined\" | \"lens\"

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#value","title":"value","text":"

\u2022 Optional value: PropsValue<Value>

"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/","title":"Renderer.Component.SettingLayoutProps","text":"

@k8slens/extensions / Exports / Renderer / Component / SettingLayoutProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#interface-settinglayoutprops","title":"Interface: SettingLayoutProps","text":"

Renderer.Component.SettingLayoutProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#hierarchy","title":"Hierarchy","text":"
  • DOMAttributes<any>

\u21b3 SettingLayoutProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#properties","title":"Properties","text":"
  • back
  • className
  • closeButtonProps
  • contentClass
  • contentGaps
  • navigation
  • provideBackButtonNavigation
"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#back","title":"back","text":"

\u2022 Optional back: (evt: MouseEvent<Element, MouseEvent> | KeyboardEvent) => void

"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#type-declaration","title":"Type declaration","text":"

\u25b8 (evt): void

"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#parameters","title":"Parameters","text":"Name Type evt MouseEvent<Element, MouseEvent> | KeyboardEvent"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#classname","title":"className","text":"

\u2022 Optional className: IClassName

"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#closebuttonprops","title":"closeButtonProps","text":"

\u2022 Optional closeButtonProps: Object

"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#type-declaration_1","title":"Type declaration","text":"Name Type data-testid? string"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#contentclass","title":"contentClass","text":"

\u2022 Optional contentClass: IClassName

"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#contentgaps","title":"contentGaps","text":"

\u2022 Optional contentGaps: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#navigation","title":"navigation","text":"

\u2022 Optional navigation: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#providebackbuttonnavigation","title":"provideBackButtonNavigation","text":"

\u2022 Optional provideBackButtonNavigation: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/","title":"Renderer.Component.SliderProps","text":"

@k8slens/extensions / Exports / Renderer / Component / SliderProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#interface-sliderprops","title":"Interface: SliderProps","text":"

Renderer.Component.SliderProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#hierarchy","title":"Hierarchy","text":"
  • Omit<MaterialSliderProps, \"onChange\">

\u21b3 SliderProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#properties","title":"Properties","text":"
  • className
"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#methods","title":"Methods","text":"
  • onChange
"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#overrides","title":"Overrides","text":"

Omit.className

"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#onchange","title":"onChange","text":"

\u25b8 onChange(evt, value): void

"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#parameters","title":"Parameters","text":"Name Type evt FormEvent<any> value number"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/","title":"Renderer.Component.SpinnerProps","text":"

@k8slens/extensions / Exports / Renderer / Component / SpinnerProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#interface-spinnerprops","title":"Interface: SpinnerProps","text":"

Renderer.Component.SpinnerProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#hierarchy","title":"Hierarchy","text":"
  • HTMLProps<any>

\u21b3 SpinnerProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#properties","title":"Properties","text":"
  • center
  • singleColor
"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#center","title":"center","text":"

\u2022 Optional center: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#singlecolor","title":"singleColor","text":"

\u2022 Optional singleColor: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.StatusBrickProps/","title":"Renderer.Component.StatusBrickProps","text":"

@k8slens/extensions / Exports / Renderer / Component / StatusBrickProps

"},{"location":"extensions/api/interfaces/Renderer.Component.StatusBrickProps/#interface-statusbrickprops","title":"Interface: StatusBrickProps","text":"

Renderer.Component.StatusBrickProps

"},{"location":"extensions/api/interfaces/Renderer.Component.StatusBrickProps/#hierarchy","title":"Hierarchy","text":"
  • HTMLAttributes<HTMLDivElement>

\u21b3 StatusBrickProps

"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/","title":"Renderer.Component.StepperProps","text":"

@k8slens/extensions / Exports / Renderer / Component / StepperProps

"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#interface-stepperprops","title":"Interface: StepperProps","text":"

Renderer.Component.StepperProps

"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#hierarchy","title":"Hierarchy","text":"
  • HTMLProps<any>

\u21b3 StepperProps

"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#properties","title":"Properties","text":"
  • step
  • steps
"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#step","title":"step","text":"

\u2022 step: number

"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#overrides","title":"Overrides","text":"

React.HTMLProps.step

"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#steps","title":"steps","text":"

\u2022 steps: Step[]

"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/","title":"Renderer.Component.SubTitleProps","text":"

@k8slens/extensions / Exports / Renderer / Component / SubTitleProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#interface-subtitleprops","title":"Interface: SubTitleProps","text":"

Renderer.Component.SubTitleProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#properties","title":"Properties","text":"
  • children
  • className
  • compact
  • id
  • title
"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#children","title":"children","text":"

\u2022 Optional children: SingleOrMany<ReactNode>

"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#compact","title":"compact","text":"

\u2022 Optional compact: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#id","title":"id","text":"

\u2022 Optional id: string

"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#title","title":"title","text":"

\u2022 title: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/","title":"Renderer.Component.SwitchProps","text":"

@k8slens/extensions / Exports / Renderer / Component / SwitchProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#interface-switchprops","title":"Interface: SwitchProps","text":"

Renderer.Component.SwitchProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#hierarchy","title":"Hierarchy","text":"
  • Omit<HTMLProps<HTMLInputElement>, \"onChange\">

\u21b3 SwitchProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#properties","title":"Properties","text":"
  • onChange
"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#onchange","title":"onChange","text":"

\u2022 Optional onChange: (checked: boolean, event: ChangeEvent<HTMLInputElement>) => void

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#type-declaration","title":"Type declaration","text":"

\u25b8 (checked, event): void

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#parameters","title":"Parameters","text":"Name Type checked boolean event ChangeEvent<HTMLInputElement>"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/","title":"Renderer.Component.SwitcherProps","text":"

@k8slens/extensions / Exports / Renderer / Component / SwitcherProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#interface-switcherprops","title":"Interface: SwitcherProps","text":"

Renderer.Component.SwitcherProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#properties","title":"Properties","text":"
  • checked
  • children
  • disabled
  • name
  • onChange
"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#checked","title":"checked","text":"

\u2022 Optional checked: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#children","title":"children","text":"

\u2022 Optional children: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#disabled","title":"disabled","text":"

\u2022 Optional disabled: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#name","title":"name","text":"

\u2022 Optional name: string

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#onchange","title":"onChange","text":"

\u2022 Optional onChange: (event: ChangeEvent<HTMLInputElement>, checked: boolean) => void

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#type-declaration","title":"Type declaration","text":"

\u25b8 (event, checked): void

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#parameters","title":"Parameters","text":"Name Type event ChangeEvent<HTMLInputElement> checked boolean"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/","title":"Renderer.Component.TabLayoutProps","text":"

@k8slens/extensions / Exports / Renderer / Component / TabLayoutProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#interface-tablayoutprops","title":"Interface: TabLayoutProps","text":"

Renderer.Component.TabLayoutProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#properties","title":"Properties","text":"
  • children
  • className
  • contentClass
  • scrollable
  • tabs
"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#children","title":"children","text":"

\u2022 Optional children: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#classname","title":"className","text":"

\u2022 Optional className: IClassName

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#contentclass","title":"contentClass","text":"

\u2022 Optional contentClass: IClassName

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#scrollable","title":"scrollable","text":"

\u2022 Optional scrollable: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#tabs","title":"tabs","text":"

\u2022 Optional tabs: TabLayoutRoute[]

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/","title":"Renderer.Component.TabLayoutRoute","text":"

@k8slens/extensions / Exports / Renderer / Component / TabLayoutRoute

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#interface-tablayoutroute","title":"Interface: TabLayoutRoute","text":"

Renderer.Component.TabLayoutRoute

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#properties","title":"Properties","text":"
  • component
  • default
  • exact
  • routePath
  • title
  • url
"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#component","title":"component","text":"

\u2022 component: ComponentType<any>

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#default","title":"default","text":"

\u2022 Optional default: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#exact","title":"exact","text":"

\u2022 Optional exact: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#routepath","title":"routePath","text":"

\u2022 routePath: string

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#title","title":"title","text":"

\u2022 title: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#url","title":"url","text":"

\u2022 Optional url: string

"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/","title":"Renderer.Component.TabProps","text":"

@k8slens/extensions / Exports / Renderer / Component / TabProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#interface-tabpropsd","title":"Interface: TabProps<D>","text":"

Renderer.Component.TabProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#type-parameters","title":"Type parameters","text":"Name D"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#hierarchy","title":"Hierarchy","text":"
  • DOMAttributes<HTMLElement>

\u21b3 TabProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#properties","title":"Properties","text":"
  • active
  • className
  • disabled
  • icon
  • id
  • label
  • value
"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#active","title":"active","text":"

\u2022 Optional active: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#disabled","title":"disabled","text":"

\u2022 Optional disabled: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#icon","title":"icon","text":"

\u2022 Optional icon: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#id","title":"id","text":"

\u2022 Optional id: string

"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#label","title":"label","text":"

\u2022 Optional label: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#value","title":"value","text":"

\u2022 value: D

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/","title":"Renderer.Component.TableCellProps","text":"

@k8slens/extensions / Exports / Renderer / Component / TableCellProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#interface-tablecellprops","title":"Interface: TableCellProps","text":"

Renderer.Component.TableCellProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#hierarchy","title":"Hierarchy","text":"
  • DOMAttributes<HTMLDivElement>

\u21b3 TableCellProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#properties","title":"Properties","text":"
  • _nowrap
  • _sorting
  • checkbox
  • className
  • data-testid
  • id
  • isChecked
  • scrollable
  • showWithColumn
  • sortBy
  • title
"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#methods","title":"Methods","text":"
  • _sort
"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#_nowrap","title":"_nowrap","text":"

\u2022 Optional _nowrap: boolean

indicator, might come from parent , don't use this prop outside (!)"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#_sorting","title":"_sorting","text":"

\u2022 Optional _sorting: Partial<TableSortParams>

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#checkbox","title":"checkbox","text":"

\u2022 Optional checkbox: boolean

render cell with a checkbox

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#classname","title":"className","text":"

\u2022 Optional className: string

Any css class names for this table cell. Only used if title is a \"simple\" react node

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#data-testid","title":"data-testid","text":"

\u2022 Optional data-testid: string

For passing in the testid

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#id","title":"id","text":"

\u2022 Optional id: string

used for configuration visibility of columns

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#ischecked","title":"isChecked","text":"

\u2022 Optional isChecked: boolean

mark checkbox as checked or not

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#scrollable","title":"scrollable","text":"

\u2022 Optional scrollable: boolean

content inside could be scrolled

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#showwithcolumn","title":"showWithColumn","text":"

\u2022 Optional showWithColumn: string

id of the column which follow same visibility rules

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#sortby","title":"sortBy","text":"

\u2022 Optional sortBy: string

column name, must be same as key in sortable object <Table sortable={}></Table>

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#title","title":"title","text":"

\u2022 Optional title: ReactNode

The actual value of the cell

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#_sort","title":"_sort","text":"

\u25b8 Optional _sort(sortBy): void

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#parameters","title":"Parameters","text":"Name Type sortBy string"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/","title":"Renderer.Component.TableHeadProps","text":"

@k8slens/extensions / Exports / Renderer / Component / TableHeadProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#interface-tableheadprops","title":"Interface: TableHeadProps","text":"

Renderer.Component.TableHeadProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#hierarchy","title":"Hierarchy","text":"
  • DOMAttributes<HTMLDivElement>

\u21b3 TableHeadProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#properties","title":"Properties","text":"
  • className
  • flat
  • nowrap
  • showTopLine
  • sticky
"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#flat","title":"flat","text":"

\u2022 Optional flat: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#nowrap","title":"nowrap","text":"

\u2022 Optional nowrap: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#showtopline","title":"showTopLine","text":"

\u2022 Optional showTopLine: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#sticky","title":"sticky","text":"

\u2022 Optional sticky: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/","title":"Renderer.Component.TableProps","text":"

@k8slens/extensions / Exports / Renderer / Component / TableProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#interface-tablepropsitem","title":"Interface: TableProps<Item>","text":"

Renderer.Component.TableProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#type-parameters","title":"Type parameters","text":"Name Item"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#hierarchy","title":"Hierarchy","text":"
  • DOMAttributes<HTMLDivElement>

\u21b3 TableProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#properties","title":"Properties","text":"
  • autoSize
  • className
  • customRowHeights
  • getTableRow
  • items
  • noItems
  • onSort
  • renderRow
  • rowLineHeight
  • rowPadding
  • scrollable
  • selectable
  • selectedItemId
  • sortByDefault
  • sortSyncWithUrl
  • sortable
  • storageKey
  • tableId
  • virtual
  • virtualHeight
"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#autosize","title":"autoSize","text":"

\u2022 Optional autoSize: boolean

Setup auto-sizing for all columns (flex: 1 0)

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#classname","title":"className","text":"

\u2022 Optional className: string

Optional addition class names for the root HTML element

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#customrowheights","title":"customRowHeights","text":"

\u2022 Optional customRowHeights: (item: Item, lineHeight: number, paddings: number) => number

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#type-declaration","title":"Type declaration","text":"

\u25b8 (item, lineHeight, paddings): number

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#parameters","title":"Parameters","text":"Name Type item Item lineHeight number paddings number"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#returns","title":"Returns","text":"

number

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#gettablerow","title":"getTableRow","text":"

\u2022 Optional getTableRow: (uid: string) => undefined | null | ReactElement<TableRowProps<Item>, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (uid): undefined | null | ReactElement<TableRowProps<Item>, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#parameters_1","title":"Parameters","text":"Name Type uid string"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#returns_1","title":"Returns","text":"

undefined | null | ReactElement<TableRowProps<Item>, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#items","title":"items","text":"

\u2022 Optional items: Item[]

The raw data for the table

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#noitems","title":"noItems","text":"

\u2022 Optional noItems: ReactNode

This is shown when items is empty

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#onsort","title":"onSort","text":"

\u2022 Optional onSort: (params: TableSortParams) => void

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (params): void

callback on sort change

Default: global sync with url

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#parameters_2","title":"Parameters","text":"Name Type params TableSortParams"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#renderrow","title":"renderRow","text":"

\u2022 Optional renderRow: (item: Item) => undefined | null | ReactElement<TableRowProps<Item>, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (item): undefined | null | ReactElement<TableRowProps<Item>, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#parameters_3","title":"Parameters","text":"Name Type item Item"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#returns_3","title":"Returns","text":"

undefined | null | ReactElement<TableRowProps<Item>, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#rowlineheight","title":"rowLineHeight","text":"

\u2022 Optional rowLineHeight: number

Row line height in pixels

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#rowpadding","title":"rowPadding","text":"

\u2022 Optional rowPadding: number

Row padding in pixels

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#scrollable","title":"scrollable","text":"

\u2022 Optional scrollable: boolean

Use scrollbar if content is bigger than parent's height

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#selectable","title":"selectable","text":"

\u2022 Optional selectable: boolean

Highlight rows on hover

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#selecteditemid","title":"selectedItemId","text":"

\u2022 Optional selectedItemId: string

Allows to scroll list to selected item

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#sortbydefault","title":"sortByDefault","text":"

\u2022 Optional sortByDefault: Partial<TableSortParams>

default sorting params

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#sortsyncwithurl","title":"sortSyncWithUrl","text":"

\u2022 Optional sortSyncWithUrl: boolean

sorting state is managed globally from url params

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#sortable","title":"sortable","text":"

\u2022 Optional sortable: TableSortCallbacks<Item>

Define sortable callbacks for every column in <TableHead><TableCell sortBy=\"someCol\"></TableCell></TableHead>

Sort Item

argument in the callback is an object, provided in <TableRow sortItem={someColDataItem}></TableRow>

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#storagekey","title":"storageKey","text":"

\u2022 Optional storageKey: string

Deprecated

Unused

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#tableid","title":"tableId","text":"

\u2022 Optional tableId: string

Used for persisting sort order and visible columns

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#virtual","title":"virtual","text":"

\u2022 Optional virtual: boolean

Use virtual list component to render only visible rows. By default uses a auto sizer to fill available height

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#virtualheight","title":"virtualHeight","text":"

\u2022 Optional virtualHeight: number

Only used when virtual is true. Sets the virtual list to be a fixed height. Needed when used in contexts that already have a parent component that is overflow-y: scroll,

"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/","title":"Renderer.Component.TableRowProps","text":"

@k8slens/extensions / Exports / Renderer / Component / TableRowProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#interface-tablerowpropsitem","title":"Interface: TableRowProps<Item>","text":"

Renderer.Component.TableRowProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#type-parameters","title":"Type parameters","text":"Name Item"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#hierarchy","title":"Hierarchy","text":"
  • DOMAttributes<HTMLDivElement>

\u21b3 TableRowProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#properties","title":"Properties","text":"
  • className
  • disabled
  • nowrap
  • searchItem
  • selected
  • sortItem
  • style
  • testId
"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#disabled","title":"disabled","text":"

\u2022 Optional disabled: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#nowrap","title":"nowrap","text":"

\u2022 Optional nowrap: boolean

Should the inner <TableCell> be aligned to one line white-space: nowrap

"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#searchitem","title":"searchItem","text":"

\u2022 Optional searchItem: Item

data for searching filters in <Table searchable={}></Table>

"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#selected","title":"selected","text":"

\u2022 Optional selected: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#sortitem","title":"sortItem","text":"

\u2022 Optional sortItem: Item

data for sorting callback in <Table sortable={}></Table>

"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#style","title":"style","text":"

\u2022 Optional style: CSSProperties

"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#testid","title":"testId","text":"

\u2022 Optional testId: string

"},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/","title":"Renderer.Component.TableSortParams","text":"

@k8slens/extensions / Exports / Renderer / Component / TableSortParams

"},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/#interface-tablesortparams","title":"Interface: TableSortParams","text":"

Renderer.Component.TableSortParams

"},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/#properties","title":"Properties","text":"
  • orderBy
  • sortBy
"},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/#orderby","title":"orderBy","text":"

\u2022 orderBy: TableOrderBy

"},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/#sortby","title":"sortBy","text":"

\u2022 sortBy: string

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/","title":"Renderer.Component.TabsProps","text":"

@k8slens/extensions / Exports / Renderer / Component / TabsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#interface-tabspropsd","title":"Interface: TabsProps<D>","text":"

Renderer.Component.TabsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#type-parameters","title":"Type parameters","text":"Name D"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#hierarchy","title":"Hierarchy","text":"
  • TabsContextValue<D>

  • Omit<DOMAttributes<HTMLElement>, \"onChange\">

\u21b3 TabsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#properties","title":"Properties","text":"
  • autoFocus
  • center
  • className
  • scrollable
  • value
  • withBorder
  • wrap
"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#methods","title":"Methods","text":"
  • onChange
"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#autofocus","title":"autoFocus","text":"

\u2022 Optional autoFocus: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#inherited-from","title":"Inherited from","text":"

TabsContextValue.autoFocus

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#center","title":"center","text":"

\u2022 Optional center: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#scrollable","title":"scrollable","text":"

\u2022 Optional scrollable: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#value","title":"value","text":"

\u2022 Optional value: D

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#inherited-from_1","title":"Inherited from","text":"

TabsContextValue.value

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#withborder","title":"withBorder","text":"

\u2022 Optional withBorder: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#inherited-from_2","title":"Inherited from","text":"

TabsContextValue.withBorder

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#wrap","title":"wrap","text":"

\u2022 Optional wrap: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#onchange","title":"onChange","text":"

\u25b8 Optional onChange(value): void

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#parameters","title":"Parameters","text":"Name Type value D"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#inherited-from_3","title":"Inherited from","text":"

TabsContextValue.onChange

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/","title":"Renderer.Component.TooltipContentFormatters","text":"

@k8slens/extensions / Exports / Renderer / Component / TooltipContentFormatters

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#interface-tooltipcontentformatters","title":"Interface: TooltipContentFormatters","text":"

Renderer.Component.TooltipContentFormatters

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#properties","title":"Properties","text":"
  • narrow
  • nowrap
  • small
  • tableView
  • warning
"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#narrow","title":"narrow","text":"

\u2022 Optional narrow: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#nowrap","title":"nowrap","text":"

\u2022 Optional nowrap: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#small","title":"small","text":"

\u2022 Optional small: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#tableview","title":"tableView","text":"

\u2022 Optional tableView: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#warning","title":"warning","text":"

\u2022 Optional warning: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/","title":"Renderer.Component.TooltipDecoratorProps","text":"

@k8slens/extensions / Exports / Renderer / Component / TooltipDecoratorProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#interface-tooltipdecoratorprops","title":"Interface: TooltipDecoratorProps","text":"

Renderer.Component.TooltipDecoratorProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#properties","title":"Properties","text":"
  • children
  • id
  • tooltip
  • tooltipOverrideDisabled
"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#children","title":"children","text":"

\u2022 Optional children: SingleOrMany<ReactNode>

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#id","title":"id","text":"

\u2022 Optional id: string

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#tooltip","title":"tooltip","text":"

\u2022 Optional tooltip: ReactNode | Omit<TooltipProps, \"targetId\">

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#tooltipoverridedisabled","title":"tooltipOverrideDisabled","text":"

\u2022 Optional tooltipOverrideDisabled: boolean

forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is \"disabled\"

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/","title":"Renderer.Component.TooltipProps","text":"

@k8slens/extensions / Exports / Renderer / Component / TooltipProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#interface-tooltipprops","title":"Interface: TooltipProps","text":"

Renderer.Component.TooltipProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#properties","title":"Properties","text":"
  • children
  • className
  • data-testid
  • formatters
  • offset
  • preferredPositions
  • style
  • targetId
  • tooltipOnParentHover
  • usePortal
  • visible
"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#children","title":"children","text":"

\u2022 Optional children: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#classname","title":"className","text":"

\u2022 Optional className: IClassName

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#data-testid","title":"data-testid","text":"

\u2022 Optional data-testid: string

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#formatters","title":"formatters","text":"

\u2022 Optional formatters: TooltipContentFormatters

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#offset","title":"offset","text":"

\u2022 Optional offset: number

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#preferredpositions","title":"preferredPositions","text":"

\u2022 Optional preferredPositions: TooltipPosition | TooltipPosition[]

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#style","title":"style","text":"

\u2022 Optional style: CSSProperties

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#targetid","title":"targetId","text":"

\u2022 targetId: string

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#tooltiponparenthover","title":"tooltipOnParentHover","text":"

\u2022 Optional tooltipOnParentHover: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#useportal","title":"usePortal","text":"

\u2022 Optional usePortal: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#visible","title":"visible","text":"

\u2022 Optional visible: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/","title":"Renderer.Component.WizardCommonProps","text":"

@k8slens/extensions / Exports / Renderer / Component / WizardCommonProps

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#interface-wizardcommonpropsd","title":"Interface: WizardCommonProps<D>","text":"

Renderer.Component.WizardCommonProps

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#type-parameters","title":"Type parameters","text":"Name D"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#hierarchy","title":"Hierarchy","text":"
  • WizardCommonProps

\u21b3 WizardProps

\u21b3 WizardStepProps

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#properties","title":"Properties","text":"
  • data
  • done
  • hideSteps
  • reset
  • save
"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#data","title":"data","text":"

\u2022 Optional data: Partial<D>

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#done","title":"done","text":"

\u2022 Optional done: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#type-declaration","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#hidesteps","title":"hideSteps","text":"

\u2022 Optional hideSteps: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#reset","title":"reset","text":"

\u2022 Optional reset: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#save","title":"save","text":"

\u2022 Optional save: (data: Partial<D>, callback?: () => void) => void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (data, callback?): void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#parameters","title":"Parameters","text":"Name Type data Partial<D> callback? () => void"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/","title":"Renderer.Component.WizardLayoutProps","text":"

@k8slens/extensions / Exports / Renderer / Component / WizardLayoutProps

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#interface-wizardlayoutprops","title":"Interface: WizardLayoutProps","text":"

Renderer.Component.WizardLayoutProps

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#hierarchy","title":"Hierarchy","text":"
  • DOMAttributes<any>

\u21b3 WizardLayoutProps

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#properties","title":"Properties","text":"
  • centered
  • className
  • contentClass
  • header
  • headerClass
  • infoPanel
  • infoPanelClass
"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#centered","title":"centered","text":"

\u2022 Optional centered: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#classname","title":"className","text":"

\u2022 Optional className: IClassName

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#contentclass","title":"contentClass","text":"

\u2022 Optional contentClass: IClassName

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#header","title":"header","text":"

\u2022 Optional header: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#headerclass","title":"headerClass","text":"

\u2022 Optional headerClass: IClassName

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#infopanel","title":"infoPanel","text":"

\u2022 Optional infoPanel: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#infopanelclass","title":"infoPanelClass","text":"

\u2022 Optional infoPanelClass: IClassName

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/","title":"Renderer.Component.WizardProps","text":"

@k8slens/extensions / Exports / Renderer / Component / WizardProps

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#interface-wizardpropsd","title":"Interface: WizardProps<D>","text":"

Renderer.Component.WizardProps

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#type-parameters","title":"Type parameters","text":"Name D"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#hierarchy","title":"Hierarchy","text":"
  • WizardCommonProps<D>

\u21b3 WizardProps

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#properties","title":"Properties","text":"
  • children
  • className
  • data
  • done
  • header
  • hideSteps
  • onChange
  • reset
  • save
  • step
  • title
"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#children","title":"children","text":"

\u2022 Optional children: ReactElement<WizardStepProps<D>, string | JSXElementConstructor<any>> | ReactElement<WizardStepProps<D>, string | JSXElementConstructor<any>>[]

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#data","title":"data","text":"

\u2022 Optional data: Partial<D>

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#inherited-from","title":"Inherited from","text":"

WizardCommonProps.data

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#done","title":"done","text":"

\u2022 Optional done: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#type-declaration","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#inherited-from_1","title":"Inherited from","text":"

WizardCommonProps.done

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#header","title":"header","text":"

\u2022 Optional header: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#hidesteps","title":"hideSteps","text":"

\u2022 Optional hideSteps: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#inherited-from_2","title":"Inherited from","text":"

WizardCommonProps.hideSteps

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#onchange","title":"onChange","text":"

\u2022 Optional onChange: (step: number) => void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (step): void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#parameters","title":"Parameters","text":"Name Type step number"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#reset","title":"reset","text":"

\u2022 Optional reset: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#inherited-from_3","title":"Inherited from","text":"

WizardCommonProps.reset

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#save","title":"save","text":"

\u2022 Optional save: (data: Partial<D>, callback?: () => void) => void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (data, callback?): void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#parameters_1","title":"Parameters","text":"Name Type data Partial<D> callback? () => void"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#inherited-from_4","title":"Inherited from","text":"

WizardCommonProps.save

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#step","title":"step","text":"

\u2022 Optional step: number

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#title","title":"title","text":"

\u2022 Optional title: string

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/","title":"Renderer.Component.WizardStepProps","text":"

@k8slens/extensions / Exports / Renderer / Component / WizardStepProps

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#interface-wizardsteppropsd","title":"Interface: WizardStepProps<D>","text":"

Renderer.Component.WizardStepProps

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#type-parameters","title":"Type parameters","text":"Name D"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#hierarchy","title":"Hierarchy","text":"
  • WizardCommonProps<D>

\u21b3 WizardStepProps

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#properties","title":"Properties","text":"
  • afterContent
  • beforeContent
  • children
  • className
  • contentClass
  • customButtons
  • data
  • disabledNext
  • done
  • first
  • hideBackBtn
  • hideNextBtn
  • hideSteps
  • isFirst
  • isLast
  • last
  • loading
  • moreButtons
  • next
  • nextLabel
  • noValidate
  • prev
  • prevLabel
  • reset
  • save
  • scrollable
  • skip
  • step
  • testIdForNext
  • testIdForPrev
  • title
  • waiting
  • wizard
"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#aftercontent","title":"afterContent","text":"

\u2022 Optional afterContent: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#beforecontent","title":"beforeContent","text":"

\u2022 Optional beforeContent: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#children","title":"children","text":"

\u2022 Optional children: ReactNode | ReactNode[]

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#classname","title":"className","text":"

\u2022 Optional className: string | object

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#contentclass","title":"contentClass","text":"

\u2022 Optional contentClass: string | object

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#custombuttons","title":"customButtons","text":"

\u2022 Optional customButtons: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#data","title":"data","text":"

\u2022 Optional data: Partial<D>

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#inherited-from","title":"Inherited from","text":"

WizardCommonProps.data

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#disablednext","title":"disabledNext","text":"

\u2022 Optional disabledNext: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#done","title":"done","text":"

\u2022 Optional done: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#type-declaration","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#inherited-from_1","title":"Inherited from","text":"

WizardCommonProps.done

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#first","title":"first","text":"

\u2022 Optional first: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#hidebackbtn","title":"hideBackBtn","text":"

\u2022 Optional hideBackBtn: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#hidenextbtn","title":"hideNextBtn","text":"

\u2022 Optional hideNextBtn: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#hidesteps","title":"hideSteps","text":"

\u2022 Optional hideSteps: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#inherited-from_2","title":"Inherited from","text":"

WizardCommonProps.hideSteps

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#isfirst","title":"isFirst","text":"

\u2022 Optional isFirst: () => boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (): boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#returns_2","title":"Returns","text":"

boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#islast","title":"isLast","text":"

\u2022 Optional isLast: () => boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (): boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#returns_3","title":"Returns","text":"

boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#last","title":"last","text":"

\u2022 Optional last: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#returns_4","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#loading","title":"loading","text":"

\u2022 Optional loading: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#morebuttons","title":"moreButtons","text":"

\u2022 Optional moreButtons: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#next","title":"next","text":"

\u2022 Optional next: () => boolean | void | Promise<any>

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (): boolean | void | Promise<any>

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#returns_5","title":"Returns","text":"

boolean | void | Promise<any>

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#nextlabel","title":"nextLabel","text":"

\u2022 Optional nextLabel: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#novalidate","title":"noValidate","text":"

\u2022 Optional noValidate: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#prev","title":"prev","text":"

\u2022 Optional prev: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#returns_6","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#prevlabel","title":"prevLabel","text":"

\u2022 Optional prevLabel: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#reset","title":"reset","text":"

\u2022 Optional reset: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#returns_7","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#inherited-from_3","title":"Inherited from","text":"

WizardCommonProps.reset

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#save","title":"save","text":"

\u2022 Optional save: (data: Partial<D>, callback?: () => void) => void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (data, callback?): void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#parameters","title":"Parameters","text":"Name Type data Partial<D> callback? () => void"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#returns_8","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#inherited-from_4","title":"Inherited from","text":"

WizardCommonProps.save

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#scrollable","title":"scrollable","text":"

\u2022 Optional scrollable: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#skip","title":"skip","text":"

\u2022 Optional skip: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#step","title":"step","text":"

\u2022 Optional step: number

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#testidfornext","title":"testIdForNext","text":"

\u2022 Optional testIdForNext: string

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#testidforprev","title":"testIdForPrev","text":"

\u2022 Optional testIdForPrev: string

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#title","title":"title","text":"

\u2022 Optional title: string

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#waiting","title":"waiting","text":"

\u2022 Optional waiting: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#wizard","title":"wizard","text":"

\u2022 Optional wizard: Wizard<D>

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/","title":"Renderer.K8sApi.KubeObjectStatus","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / KubeObjectStatus

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#interface-kubeobjectstatus","title":"Interface: KubeObjectStatus","text":"

Renderer.K8sApi.KubeObjectStatus

Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#properties","title":"Properties","text":"
  • level
  • text
  • timestamp
"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#level","title":"level","text":"

\u2022 level: KubeObjectStatusLevel

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#text","title":"text","text":"

\u2022 text: string

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#timestamp","title":"timestamp","text":"

\u2022 Optional timestamp: string

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricData/","title":"Renderer.K8sApi.MetricData","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / MetricData

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricData/#interface-metricdata","title":"Interface: MetricData","text":"

Renderer.K8sApi.MetricData

Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricData/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricData/#properties","title":"Properties","text":"
  • data
  • status
"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricData/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricData/#data","title":"data","text":"

\u2022 data: Object

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricData/#type-declaration","title":"Type declaration","text":"Name Type result MetricResult[] resultType string"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricData/#status","title":"status","text":"

\u2022 status: string

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricResult/","title":"Renderer.K8sApi.MetricResult","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / MetricResult

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricResult/#interface-metricresult","title":"Interface: MetricResult","text":"

Renderer.K8sApi.MetricResult

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricResult/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricResult/#properties","title":"Properties","text":"
  • metric
  • values
"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricResult/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricResult/#metric","title":"metric","text":"

\u2022 metric: Object

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricResult/#index-signature","title":"Index signature","text":"

\u25aa [name: string]: string | undefined

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricResult/#type-declaration","title":"Type declaration","text":"Name Type instance? string kubernetes? string kubernetes_namespace? string kubernetes_node? string node? string pod? string"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricResult/#values","title":"values","text":"

\u2022 values: [number, string][]

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/","title":"Renderer.K8sApi.RequestMetricsParams","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / RequestMetricsParams

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#interface-requestmetricsparams","title":"Interface: RequestMetricsParams","text":"

Renderer.K8sApi.RequestMetricsParams

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#properties","title":"Properties","text":"
  • end
  • namespace
  • range
  • start
  • step
"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#end","title":"end","text":"

\u2022 Optional end: string | number

timestamp in seconds or valid date-string

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#namespace","title":"namespace","text":"

\u2022 Optional namespace: string

rbac-proxy validation param

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#range","title":"range","text":"

\u2022 Optional range: number

time-range in seconds for data aggregation

Default

3600 (1 hour)\n
"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#start","title":"start","text":"

\u2022 Optional start: string | number

timestamp in seconds or valid date-string

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#step","title":"step","text":"

\u2022 Optional step: number

step in seconds

Default

60 (1 minute)\n
"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/","title":"Renderer.Navigation.PageParamInit","text":"

@k8slens/extensions / Exports / Renderer / Navigation / PageParamInit

"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#interface-pageparaminitvalue","title":"Interface: PageParamInit<Value>","text":"

Renderer.Navigation.PageParamInit

"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#type-parameters","title":"Type parameters","text":"Name Type Value any"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#properties","title":"Properties","text":"
  • defaultValue
  • name
"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#methods","title":"Methods","text":"
  • parse
  • stringify
"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#defaultvalue","title":"defaultValue","text":"

\u2022 Optional defaultValue: Value

"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#name","title":"name","text":"

\u2022 name: string

"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#parse","title":"parse","text":"

\u25b8 Optional parse(value): Value

"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#parameters","title":"Parameters","text":"Name Type value string | string[]"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#returns","title":"Returns","text":"

Value

"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#stringify","title":"stringify","text":"

\u25b8 Optional stringify(value): string | string[]

"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#parameters_1","title":"Parameters","text":"Name Type value Value"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#returns_1","title":"Returns","text":"

string | string[]

"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/","title":"Renderer.Navigation.URLParams","text":"

@k8slens/extensions / Exports / Renderer / Navigation / URLParams

"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#interface-urlparamsp-q","title":"Interface: URLParams<P, Q>","text":"

Renderer.Navigation.URLParams

"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#type-parameters","title":"Type parameters","text":"Name Type P extends object = {} Q extends object = {}"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#properties","title":"Properties","text":"
  • fragment
  • params
  • query
"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#fragment","title":"fragment","text":"

\u2022 Optional fragment: string

"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#params","title":"params","text":"

\u2022 Optional params: P

"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#query","title":"query","text":"

\u2022 Optional query: Q

"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/","title":"Renderer.Theme.LensTheme","text":"

@k8slens/extensions / Exports / Renderer / Theme / LensTheme

"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#interface-lenstheme","title":"Interface: LensTheme","text":"

Renderer.Theme.LensTheme

"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#properties","title":"Properties","text":"
  • author
  • colors
  • description
  • isDefault
  • monacoTheme
  • name
  • terminalColors
  • type
"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#author","title":"author","text":"

\u2022 author: string

"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#colors","title":"colors","text":"

\u2022 colors: Record<LensColorName, string>

"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#description","title":"description","text":"

\u2022 description: string

"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#isdefault","title":"isDefault","text":"

\u2022 Optional isDefault: boolean

"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#monacotheme","title":"monacoTheme","text":"

\u2022 monacoTheme: MonacoTheme

"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#name","title":"name","text":"

\u2022 name: string

"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#terminalcolors","title":"terminalColors","text":"

\u2022 terminalColors: Partial<Record<TerminalColorName, string>>

"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#type","title":"type","text":"

\u2022 type: LensThemeType

"},{"location":"extensions/api/modules/Common.Catalog/","title":"Common.Catalog","text":"

@k8slens/extensions / Exports / Common / Catalog

"},{"location":"extensions/api/modules/Common.Catalog/#namespace-catalog","title":"Namespace: Catalog","text":"

Common.Catalog

"},{"location":"extensions/api/modules/Common.Catalog/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Common.Catalog/#classes","title":"Classes","text":"
  • CatalogCategory
  • CatalogEntity
  • GeneralEntity
  • KubernetesCluster
  • KubernetesClusterCategory
  • WebLink
"},{"location":"extensions/api/modules/Common.Catalog/#interfaces","title":"Interfaces","text":"
  • CatalogCategoryEvents
  • CatalogCategoryMetadata
  • CatalogCategorySpec
  • CatalogCategoryVersion
  • CatalogEntityActionContext
  • CatalogEntityAddMenu
  • CatalogEntityAddMenuContext
  • CatalogEntityContextMenu
  • CatalogEntityContextMenuContext
  • CatalogEntityContextMenuNavigate
  • CatalogEntityData
  • CatalogEntityKindData
  • CatalogEntityMetadata
  • CatalogEntitySettingsContext
  • CatalogEntitySettingsMenu
  • CatalogEntityStatus
  • CategoryColumnRegistration
  • GeneralEntitySpec
  • KubernetesClusterMetadata
  • KubernetesClusterPrometheusMetrics
  • KubernetesClusterSpec
  • KubernetesClusterStatus
  • TitleCellProps
  • WebLinkSpec
  • WebLinkStatus
"},{"location":"extensions/api/modules/Common.Catalog/#type-aliases","title":"Type Aliases","text":"
  • AddMenuFilter
  • CatalogEntityConstructor
  • CatalogEntityDataFor
  • CatalogEntityInstanceFrom
  • CatalogEntitySpec
  • EntityMetadataObject
  • EntityMetadataValue
  • KubernetesClusterStatusPhase
  • WebLinkStatusPhase
"},{"location":"extensions/api/modules/Common.Catalog/#variables","title":"Variables","text":"
  • kubernetesClusterCategory
"},{"location":"extensions/api/modules/Common.Catalog/#functions","title":"Functions","text":"
  • categoryVersion
"},{"location":"extensions/api/modules/Common.Catalog/#type-aliases_1","title":"Type Aliases","text":""},{"location":"extensions/api/modules/Common.Catalog/#addmenufilter","title":"AddMenuFilter","text":"

\u01ac AddMenuFilter: (menu: CatalogEntityAddMenu) => any

"},{"location":"extensions/api/modules/Common.Catalog/#type-declaration","title":"Type declaration","text":"

\u25b8 (menu): any

If the filter return a thruthy value, the menu item is displayed

"},{"location":"extensions/api/modules/Common.Catalog/#parameters","title":"Parameters","text":"Name Type menu CatalogEntityAddMenu"},{"location":"extensions/api/modules/Common.Catalog/#returns","title":"Returns","text":"

any

"},{"location":"extensions/api/modules/Common.Catalog/#catalogentityconstructor","title":"CatalogEntityConstructor","text":"

\u01ac CatalogEntityConstructor<Entity>: (data: CatalogEntityDataFor<Entity>) => Entity

"},{"location":"extensions/api/modules/Common.Catalog/#type-parameters","title":"Type parameters","text":"Name Type Entity extends CatalogEntity"},{"location":"extensions/api/modules/Common.Catalog/#type-declaration_1","title":"Type declaration","text":"

\u2022 (data)

"},{"location":"extensions/api/modules/Common.Catalog/#parameters_1","title":"Parameters","text":"Name Type data CatalogEntityDataFor<Entity>"},{"location":"extensions/api/modules/Common.Catalog/#catalogentitydatafor","title":"CatalogEntityDataFor","text":"

\u01ac CatalogEntityDataFor<Entity>: Entity extends CatalogEntity<infer Metadata, infer Status, infer Spec> ? CatalogEntityData<Metadata, Status, Spec> : never

"},{"location":"extensions/api/modules/Common.Catalog/#type-parameters_1","title":"Type parameters","text":"Name Entity"},{"location":"extensions/api/modules/Common.Catalog/#catalogentityinstancefrom","title":"CatalogEntityInstanceFrom","text":"

\u01ac CatalogEntityInstanceFrom<Constructor>: Constructor extends CatalogEntityConstructor<infer Entity> ? Entity : never

"},{"location":"extensions/api/modules/Common.Catalog/#type-parameters_2","title":"Type parameters","text":"Name Constructor"},{"location":"extensions/api/modules/Common.Catalog/#catalogentityspec","title":"CatalogEntitySpec","text":"

\u01ac CatalogEntitySpec: Record<string, any>

"},{"location":"extensions/api/modules/Common.Catalog/#entitymetadataobject","title":"EntityMetadataObject","text":"

\u01ac EntityMetadataObject: { [Key in string]?: EntityMetadataValue }

"},{"location":"extensions/api/modules/Common.Catalog/#entitymetadatavalue","title":"EntityMetadataValue","text":"

\u01ac EntityMetadataValue: string | number | boolean | EntityMetadataObject | undefined

"},{"location":"extensions/api/modules/Common.Catalog/#kubernetesclusterstatusphase","title":"KubernetesClusterStatusPhase","text":"

\u01ac KubernetesClusterStatusPhase: \"connected\" | \"connecting\" | \"disconnected\" | \"deleting\"

Deprecated

This is no longer used as it is incorrect. Other sources can add more values

"},{"location":"extensions/api/modules/Common.Catalog/#weblinkstatusphase","title":"WebLinkStatusPhase","text":"

\u01ac WebLinkStatusPhase: \"available\" | \"unavailable\"

"},{"location":"extensions/api/modules/Common.Catalog/#variables_1","title":"Variables","text":""},{"location":"extensions/api/modules/Common.Catalog/#kubernetesclustercategory","title":"kubernetesClusterCategory","text":"

\u2022 Const kubernetesClusterCategory: KubernetesClusterCategory

"},{"location":"extensions/api/modules/Common.Catalog/#functions_1","title":"Functions","text":""},{"location":"extensions/api/modules/Common.Catalog/#categoryversion","title":"categoryVersion","text":"

\u25b8 categoryVersion<T, Metadata, Status, Spec>(name, entityClass): CatalogCategoryVersion

"},{"location":"extensions/api/modules/Common.Catalog/#type-parameters_3","title":"Type parameters","text":"Name Type T extends CatalogEntity<Metadata, Status, Spec, T> Metadata extends CatalogEntityMetadata<Metadata> Status extends CatalogEntityStatus Spec extends CatalogEntitySpec"},{"location":"extensions/api/modules/Common.Catalog/#parameters_2","title":"Parameters","text":"Name Type name string entityClass (data: CatalogEntityData<Metadata, Status, Spec>) => T"},{"location":"extensions/api/modules/Common.Catalog/#returns_1","title":"Returns","text":"

CatalogCategoryVersion

"},{"location":"extensions/api/modules/Common.EventBus/","title":"Common.EventBus","text":"

@k8slens/extensions / Exports / Common / EventBus

"},{"location":"extensions/api/modules/Common.EventBus/#namespace-eventbus","title":"Namespace: EventBus","text":"

Common.EventBus

"},{"location":"extensions/api/modules/Common.EventBus/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Common.EventBus/#classes","title":"Classes","text":"
  • EventEmitter
"},{"location":"extensions/api/modules/Common.EventBus/#interfaces","title":"Interfaces","text":"
  • AppEvent
  • EventEmitterOptions
"},{"location":"extensions/api/modules/Common.EventBus/#type-aliases","title":"Type Aliases","text":"
  • EventEmitterCallback
"},{"location":"extensions/api/modules/Common.EventBus/#variables","title":"Variables","text":"
  • appEventBus
"},{"location":"extensions/api/modules/Common.EventBus/#type-aliases_1","title":"Type Aliases","text":""},{"location":"extensions/api/modules/Common.EventBus/#eventemittercallback","title":"EventEmitterCallback","text":"

\u01ac EventEmitterCallback<D>: (...data: D) => void | boolean

"},{"location":"extensions/api/modules/Common.EventBus/#type-parameters","title":"Type parameters","text":"Name Type D extends any[]"},{"location":"extensions/api/modules/Common.EventBus/#type-declaration","title":"Type declaration","text":"

\u25b8 (...data): void | boolean

"},{"location":"extensions/api/modules/Common.EventBus/#parameters","title":"Parameters","text":"Name Type ...data D"},{"location":"extensions/api/modules/Common.EventBus/#returns","title":"Returns","text":"

void | boolean

"},{"location":"extensions/api/modules/Common.EventBus/#variables_1","title":"Variables","text":""},{"location":"extensions/api/modules/Common.EventBus/#appeventbus","title":"appEventBus","text":"

\u2022 Const appEventBus: EventEmitter<[AppEvent]>

"},{"location":"extensions/api/modules/Common.Proxy/","title":"Common.Proxy","text":"

@k8slens/extensions / Exports / Common / Proxy

"},{"location":"extensions/api/modules/Common.Proxy/#namespace-proxy","title":"Namespace: Proxy","text":"

Common.Proxy

"},{"location":"extensions/api/modules/Common.Proxy/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Common.Proxy/#functions","title":"Functions","text":"
  • resolveSystemProxy
"},{"location":"extensions/api/modules/Common.Proxy/#functions_1","title":"Functions","text":""},{"location":"extensions/api/modules/Common.Proxy/#resolvesystemproxy","title":"resolveSystemProxy","text":"

\u25b8 resolveSystemProxy(url): Promise<string>

Resolves URL-specific proxy information from system. See more here: https://www.electronjs.org/docs/latest/api/session#sesresolveproxyurl

"},{"location":"extensions/api/modules/Common.Proxy/#parameters","title":"Parameters","text":"Name Type Description url string The URL for proxy information"},{"location":"extensions/api/modules/Common.Proxy/#returns","title":"Returns","text":"

Promise<string>

Promise for proxy information as string

"},{"location":"extensions/api/modules/Common.Store/","title":"Common.Store","text":"

@k8slens/extensions / Exports / Common / Store

"},{"location":"extensions/api/modules/Common.Store/#namespace-store","title":"Namespace: Store","text":"

Common.Store

"},{"location":"extensions/api/modules/Common.Store/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Common.Store/#classes","title":"Classes","text":"
  • ExtensionStore
"},{"location":"extensions/api/modules/Common.Store/#interfaces","title":"Interfaces","text":"
  • ExtensionStoreParams
  • PersistentStorageParams
"},{"location":"extensions/api/modules/Common.Types/","title":"Common.Types","text":"

@k8slens/extensions / Exports / Common / Types

"},{"location":"extensions/api/modules/Common.Types/#namespace-types","title":"Namespace: Types","text":"

Common.Types

"},{"location":"extensions/api/modules/Common.Types/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Common.Types/#interfaces","title":"Interfaces","text":"
  • AppPreferenceComponents
  • AppPreferenceRegistration
  • ClusterPageMenuComponents
  • ClusterPageMenuRegistration
  • CustomCategoryViewComponents
  • CustomCategoryViewProps
  • CustomCategoryViewRegistration
  • KubeObjectContextMenuItem
  • KubeObjectDetailComponents
  • KubeObjectDetailRegistration
  • KubeObjectHandlers
  • KubeObjectMenuComponents
  • KubeObjectMenuRegistration
  • KubeObjectOnContextMenuOpenContext
  • KubeObjectStatusRegistration
  • PageComponentProps
  • PageComponents
  • PageParams
  • PageRegistration
  • PageTarget
  • ProtocolHandlerRegistration
  • ProtocolRouteHandler
  • ProtocolRouteParams
  • RegisteredPage
  • ShellEnvContext
  • StatusBarRegistration
  • TrayMenuRegistration
"},{"location":"extensions/api/modules/Common.Types/#type-aliases","title":"Type Aliases","text":"
  • IpcMainEvent
  • IpcMainInvokeEvent
  • IpcRendererEvent
  • KubeObjectHandlerRegistration
  • KubeObjectOnContextMenuOpen
  • MenuRegistration
  • ShellEnvModifier
"},{"location":"extensions/api/modules/Common.Types/#type-aliases_1","title":"Type Aliases","text":""},{"location":"extensions/api/modules/Common.Types/#ipcmainevent","title":"IpcMainEvent","text":"

\u01ac IpcMainEvent: Electron.IpcMainEvent

"},{"location":"extensions/api/modules/Common.Types/#ipcmaininvokeevent","title":"IpcMainInvokeEvent","text":"

\u01ac IpcMainInvokeEvent: Electron.IpcMainInvokeEvent

Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.

"},{"location":"extensions/api/modules/Common.Types/#ipcrendererevent","title":"IpcRendererEvent","text":"

\u01ac IpcRendererEvent: Electron.IpcRendererEvent

"},{"location":"extensions/api/modules/Common.Types/#kubeobjecthandlerregistration","title":"KubeObjectHandlerRegistration","text":"

\u01ac KubeObjectHandlerRegistration: { apiVersions: string[] ; kind: string } & RequireAtLeastOne<KubeObjectHandlers>

"},{"location":"extensions/api/modules/Common.Types/#kubeobjectoncontextmenuopen","title":"KubeObjectOnContextMenuOpen","text":"

\u01ac KubeObjectOnContextMenuOpen: (ctx: KubeObjectOnContextMenuOpenContext) => void

"},{"location":"extensions/api/modules/Common.Types/#type-declaration","title":"Type declaration","text":"

\u25b8 (ctx): void

"},{"location":"extensions/api/modules/Common.Types/#parameters","title":"Parameters","text":"Name Type ctx KubeObjectOnContextMenuOpenContext"},{"location":"extensions/api/modules/Common.Types/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/modules/Common.Types/#menuregistration","title":"MenuRegistration","text":"

\u01ac MenuRegistration: { parentId: string ; visible?: IComputedValue<boolean> | boolean } & Omit<MenuItemConstructorOptions, \"visible\">

"},{"location":"extensions/api/modules/Common.Types/#shellenvmodifier","title":"ShellEnvModifier","text":"

\u01ac ShellEnvModifier: (ctx: ShellEnvContext, env: Record<string, string | undefined>) => Record<string, string | undefined>

"},{"location":"extensions/api/modules/Common.Types/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (ctx, env): Record<string, string | undefined>

"},{"location":"extensions/api/modules/Common.Types/#parameters_1","title":"Parameters","text":"Name Type ctx ShellEnvContext env Record<string, string | undefined>"},{"location":"extensions/api/modules/Common.Types/#returns_1","title":"Returns","text":"

Record<string, string | undefined>

"},{"location":"extensions/api/modules/Common.Util/","title":"Common.Util","text":"

@k8slens/extensions / Exports / Common / Util

"},{"location":"extensions/api/modules/Common.Util/#namespace-util","title":"Namespace: Util","text":"

Common.Util

"},{"location":"extensions/api/modules/Common.Util/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Common.Util/#classes","title":"Classes","text":"
  • Singleton
"},{"location":"extensions/api/modules/Common.Util/#interfaces","title":"Interfaces","text":"
  • Disposable
  • Disposer
  • ExtendableDisposer
"},{"location":"extensions/api/modules/Common.Util/#type-aliases","title":"Type Aliases","text":"
  • IClassName
  • IgnoredClassNames
  • OpenLinkInBrowser
"},{"location":"extensions/api/modules/Common.Util/#functions","title":"Functions","text":"
  • cssNames
  • disposer
  • getAppVersion
  • openBrowser
  • openExternal
  • prevDefault
  • stopPropagation
"},{"location":"extensions/api/modules/Common.Util/#type-aliases_1","title":"Type Aliases","text":""},{"location":"extensions/api/modules/Common.Util/#iclassname","title":"IClassName","text":"

\u01ac IClassName: string | string[] | Record<string, any> | undefined | null | false | IgnoredClassNames

"},{"location":"extensions/api/modules/Common.Util/#ignoredclassnames","title":"IgnoredClassNames","text":"

\u01ac IgnoredClassNames: number | symbol | Function

Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.

"},{"location":"extensions/api/modules/Common.Util/#openlinkinbrowser","title":"OpenLinkInBrowser","text":"

\u01ac OpenLinkInBrowser: (url: string) => Promise<void>

"},{"location":"extensions/api/modules/Common.Util/#type-declaration","title":"Type declaration","text":"

\u25b8 (url): Promise<void>

"},{"location":"extensions/api/modules/Common.Util/#parameters","title":"Parameters","text":"Name Type url string"},{"location":"extensions/api/modules/Common.Util/#returns","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/modules/Common.Util/#functions_1","title":"Functions","text":""},{"location":"extensions/api/modules/Common.Util/#cssnames","title":"cssNames","text":"

\u25b8 cssNames(...classNames): string

"},{"location":"extensions/api/modules/Common.Util/#parameters_1","title":"Parameters","text":"Name Type ...classNames IClassName[]"},{"location":"extensions/api/modules/Common.Util/#returns_1","title":"Returns","text":"

string

"},{"location":"extensions/api/modules/Common.Util/#disposer","title":"disposer","text":"

\u25b8 disposer(...items): ExtendableDisposer

"},{"location":"extensions/api/modules/Common.Util/#parameters_2","title":"Parameters","text":"Name Type ...items SingleOrMany<undefined | null | Disposer | Disposable>[]"},{"location":"extensions/api/modules/Common.Util/#returns_2","title":"Returns","text":"

ExtendableDisposer

"},{"location":"extensions/api/modules/Common.Util/#getappversion","title":"getAppVersion","text":"

\u25b8 getAppVersion(): string

"},{"location":"extensions/api/modules/Common.Util/#returns_3","title":"Returns","text":"

string

"},{"location":"extensions/api/modules/Common.Util/#openbrowser","title":"openBrowser","text":"

\u25b8 openBrowser(url): Promise<void>

"},{"location":"extensions/api/modules/Common.Util/#parameters_3","title":"Parameters","text":"Name Type url string"},{"location":"extensions/api/modules/Common.Util/#returns_4","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/modules/Common.Util/#openexternal","title":"openExternal","text":"

\u25b8 openExternal(url): Promise<void>

"},{"location":"extensions/api/modules/Common.Util/#parameters_4","title":"Parameters","text":"Name Type url string"},{"location":"extensions/api/modules/Common.Util/#returns_5","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/modules/Common.Util/#prevdefault","title":"prevDefault","text":"

\u25b8 prevDefault<E, R>(callback): (event: E) => R

"},{"location":"extensions/api/modules/Common.Util/#type-parameters","title":"Type parameters","text":"Name Type E extends Event | SyntheticEvent<Element, Event> R R"},{"location":"extensions/api/modules/Common.Util/#parameters_5","title":"Parameters","text":"Name Type callback (evt: E) => R"},{"location":"extensions/api/modules/Common.Util/#returns_6","title":"Returns","text":"

fn

\u25b8 (event): R

"},{"location":"extensions/api/modules/Common.Util/#parameters_6","title":"Parameters","text":"Name Type event E"},{"location":"extensions/api/modules/Common.Util/#returns_7","title":"Returns","text":"

R

"},{"location":"extensions/api/modules/Common.Util/#stoppropagation","title":"stopPropagation","text":"

\u25b8 stopPropagation(evt): void

"},{"location":"extensions/api/modules/Common.Util/#parameters_7","title":"Parameters","text":"Name Type evt Event | SyntheticEvent<Element, Event>"},{"location":"extensions/api/modules/Common.Util/#returns_8","title":"Returns","text":"

void

"},{"location":"extensions/api/modules/Common/","title":"Common","text":"

@k8slens/extensions / Exports / Common

"},{"location":"extensions/api/modules/Common/#namespace-common","title":"Namespace: Common","text":"

Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.

"},{"location":"extensions/api/modules/Common/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Common/#namespaces","title":"Namespaces","text":"
  • Catalog
  • EventBus
  • Proxy
  • Store
  • Types
  • Util
"},{"location":"extensions/api/modules/Common/#classes","title":"Classes","text":"
  • LensExtension
"},{"location":"extensions/api/modules/Common/#interfaces","title":"Interfaces","text":"
  • LensExtensionManifest
  • Logger
"},{"location":"extensions/api/modules/Common/#type-aliases","title":"Type Aliases","text":"
  • InstalledExtension
"},{"location":"extensions/api/modules/Common/#variables","title":"Variables","text":"
  • App
  • logger
"},{"location":"extensions/api/modules/Common/#type-aliases_1","title":"Type Aliases","text":""},{"location":"extensions/api/modules/Common/#installedextension","title":"InstalledExtension","text":"

\u01ac InstalledExtension: BundledInstalledExtension | ExternalInstalledExtension

"},{"location":"extensions/api/modules/Common/#variables_1","title":"Variables","text":""},{"location":"extensions/api/modules/Common/#app","title":"App","text":"

\u2022 Const App: Object

Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.

"},{"location":"extensions/api/modules/Common/#type-declaration","title":"Type declaration","text":"Name Type Description Preferences { getKubectlPath: () => string | undefined } - Preferences.getKubectlPath () => string | undefined - appName string - getEnabledExtensions () => string[] - isLinux boolean - isMac boolean - isSnap boolean - isWindows boolean - issuesTrackerUrl string - lensBuildEnvironment string - slackUrl \"\" Deprecated This value is now \"\" and is left here for backwards compatibility. version string -"},{"location":"extensions/api/modules/Common/#logger","title":"logger","text":"

\u2022 Const logger: Logger

"},{"location":"extensions/api/modules/Main.Catalog/","title":"Main.Catalog","text":"

@k8slens/extensions / Exports / Main / Catalog

"},{"location":"extensions/api/modules/Main.Catalog/#namespace-catalog","title":"Namespace: Catalog","text":"

Main.Catalog

Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.

"},{"location":"extensions/api/modules/Main.Catalog/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Main.Catalog/#interfaces","title":"Interfaces","text":"
  • CatalogEntityRegistry
"},{"location":"extensions/api/modules/Main.Catalog/#variables","title":"Variables","text":"
  • catalogCategories
  • catalogEntities
"},{"location":"extensions/api/modules/Main.Catalog/#variables_1","title":"Variables","text":""},{"location":"extensions/api/modules/Main.Catalog/#catalogcategories","title":"catalogCategories","text":"

\u2022 Const catalogCategories: CatalogCategoryRegistry

"},{"location":"extensions/api/modules/Main.Catalog/#catalogentities","title":"catalogEntities","text":"

\u2022 Const catalogEntities: CatalogEntityRegistry

"},{"location":"extensions/api/modules/Main.K8sApi/","title":"Main.K8sApi","text":"

@k8slens/extensions / Exports / Main / K8sApi

"},{"location":"extensions/api/modules/Main.K8sApi/#namespace-k8sapi","title":"Namespace: K8sApi","text":"

Main.K8sApi

"},{"location":"extensions/api/modules/Main.K8sApi/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Main.K8sApi/#references","title":"References","text":"
  • createKubeObject
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isKubeObjectNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • stringifyLabels
"},{"location":"extensions/api/modules/Main.K8sApi/#classes","title":"Classes","text":"
  • ClusterRole
  • ClusterRoleBinding
  • ConfigMap
  • CronJob
  • CustomResourceDefinition
  • DaemonSet
  • Deployment
  • Endpoint
  • HorizontalPodAutoscaler
  • Ingress
  • Job
  • KubeEvent
  • KubeObject
  • KubeObjectStore
  • KubeStatus
  • LimitRange
  • Namespace
  • NetworkPolicy
  • Node
  • PersistentVolume
  • PersistentVolumeClaim
  • Pod
  • PodDisruptionBudget
  • PriorityClass
  • ReplicaSet
  • ResourceQuota
  • ResourceStack
  • Role
  • RoleBinding
  • Secret
  • Service
  • ServiceAccount
  • StatefulSet
  • StorageClass
"},{"location":"extensions/api/modules/Main.K8sApi/#interfaces","title":"Interfaces","text":"
  • BaseKubeJsonApiObjectMetadata
  • ExternalKubeApiOptions
  • IKubeApiCluster
  • ILocalKubeApiConfig
  • IPodContainer
  • IPodContainerStatus
  • IRemoteKubeApiConfig
  • ISecretRef
  • IgnoredKubeApiOptions
  • KubeJsonApiData
  • KubeObjectStoreLoadAllParams
  • KubeObjectStoreLoadingParams
  • KubeObjectStoreSubscribeParams
  • KubeStatusData
  • OwnerReference
"},{"location":"extensions/api/modules/Main.K8sApi/#type-aliases","title":"Type Aliases","text":"
  • ClusterScopedMetadata
  • DeploymentApi
  • IngressApi
  • JsonPatch
  • KubeApi
  • KubeJsonApi
  • KubeJsonApiDataFor
  • KubeJsonApiObjectMetadata
  • KubeObjectMetadata
  • NamespaceScopedMetadata
  • NodesApi
  • PersistentVolumeClaimsApi
  • PodsApi
"},{"location":"extensions/api/modules/Main.K8sApi/#variables","title":"Variables","text":"
  • DeploymentApi
  • IngressApi
  • KubeApi
  • KubeJsonApi
  • NodesApi
  • PersistentVolumeClaimsApi
  • PodsApi
  • apiManager
"},{"location":"extensions/api/modules/Main.K8sApi/#functions","title":"Functions","text":"
  • createResourceStack
  • forCluster
  • forRemoteCluster
  • getPodsByOwnerId
  • isAllowedResource
  • isKubeStatusData
"},{"location":"extensions/api/modules/Main.K8sApi/#references_1","title":"References","text":""},{"location":"extensions/api/modules/Main.K8sApi/#createkubeobject","title":"createKubeObject","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Main.K8sApi/#isjsonapidata","title":"isJsonApiData","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Main.K8sApi/#isjsonapidatalist","title":"isJsonApiDataList","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Main.K8sApi/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Main.K8sApi/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Main.K8sApi/#iskubeobjectnonsystem","title":"isKubeObjectNonSystem","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Main.K8sApi/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Main.K8sApi/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Main.K8sApi/#stringifylabels","title":"stringifyLabels","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Main.K8sApi/#type-aliases_1","title":"Type Aliases","text":""},{"location":"extensions/api/modules/Main.K8sApi/#clusterscopedmetadata","title":"ClusterScopedMetadata","text":"

\u01ac ClusterScopedMetadata: KubeObjectMetadata<KubeObjectScope.Cluster>

"},{"location":"extensions/api/modules/Main.K8sApi/#deploymentapi","title":"DeploymentApi","text":"

\u01ac DeploymentApi: InternalDeploymentApi

"},{"location":"extensions/api/modules/Main.K8sApi/#ingressapi","title":"IngressApi","text":"

\u01ac IngressApi: InternalIngressApi

"},{"location":"extensions/api/modules/Main.K8sApi/#jsonpatch","title":"JsonPatch","text":"

\u01ac JsonPatch: Patch

"},{"location":"extensions/api/modules/Main.K8sApi/#kubeapi","title":"KubeApi","text":"

\u01ac KubeApi<Object, Data>: InternalKubeApi<Object, Data>

"},{"location":"extensions/api/modules/Main.K8sApi/#type-parameters","title":"Type parameters","text":"Name Type Object extends KubeObject = KubeObject Data extends KubeJsonApiDataFor<Object> = KubeJsonApiDataFor<Object>"},{"location":"extensions/api/modules/Main.K8sApi/#kubejsonapi","title":"KubeJsonApi","text":"

\u01ac KubeJsonApi: InternalKubeJsonApi

"},{"location":"extensions/api/modules/Main.K8sApi/#kubejsonapidatafor","title":"KubeJsonApiDataFor","text":"

\u01ac KubeJsonApiDataFor<K>: K extends KubeObject<infer Metadata, infer Status, infer Spec> ? KubeJsonApiData<Metadata, Status, Spec> : never

"},{"location":"extensions/api/modules/Main.K8sApi/#type-parameters_1","title":"Type parameters","text":"Name K"},{"location":"extensions/api/modules/Main.K8sApi/#kubejsonapiobjectmetadata","title":"KubeJsonApiObjectMetadata","text":"

\u01ac KubeJsonApiObjectMetadata<Namespaced>: BaseKubeJsonApiObjectMetadata<Namespaced> & Namespaced extends KubeObjectScope.Namespace ? { namespace: string } : {}

"},{"location":"extensions/api/modules/Main.K8sApi/#type-parameters_2","title":"Type parameters","text":"Name Type Namespaced extends KubeObjectScope = KubeObjectScope"},{"location":"extensions/api/modules/Main.K8sApi/#kubeobjectmetadata","title":"KubeObjectMetadata","text":"

\u01ac KubeObjectMetadata<Namespaced>: KubeJsonApiObjectMetadata<Namespaced> & { name: string ; resourceVersion: string ; selfLink: string ; uid: string }

"},{"location":"extensions/api/modules/Main.K8sApi/#type-parameters_3","title":"Type parameters","text":"Name Type Namespaced extends KubeObjectScope = KubeObjectScope"},{"location":"extensions/api/modules/Main.K8sApi/#namespacescopedmetadata","title":"NamespaceScopedMetadata","text":"

\u01ac NamespaceScopedMetadata: KubeObjectMetadata<KubeObjectScope.Namespace>

"},{"location":"extensions/api/modules/Main.K8sApi/#nodesapi","title":"NodesApi","text":"

\u01ac NodesApi: NodeApi

"},{"location":"extensions/api/modules/Main.K8sApi/#persistentvolumeclaimsapi","title":"PersistentVolumeClaimsApi","text":"

\u01ac PersistentVolumeClaimsApi: PersistentVolumeClaimApi

"},{"location":"extensions/api/modules/Main.K8sApi/#podsapi","title":"PodsApi","text":"

\u01ac PodsApi: PodApi

"},{"location":"extensions/api/modules/Main.K8sApi/#variables_1","title":"Variables","text":""},{"location":"extensions/api/modules/Main.K8sApi/#deploymentapi_1","title":"DeploymentApi","text":"

\u2022 DeploymentApi: (opts?: DerivedKubeApiOptions) => DeploymentApi

"},{"location":"extensions/api/modules/Main.K8sApi/#type-declaration","title":"Type declaration","text":"

\u2022 new DeploymentApi(opts?)

"},{"location":"extensions/api/modules/Main.K8sApi/#parameters","title":"Parameters","text":"Name Type opts? DerivedKubeApiOptions"},{"location":"extensions/api/modules/Main.K8sApi/#ingressapi_1","title":"IngressApi","text":"

\u2022 IngressApi: (opts?: DerivedKubeApiOptions & IgnoredKubeApiOptions) => IngressApi

"},{"location":"extensions/api/modules/Main.K8sApi/#type-declaration_1","title":"Type declaration","text":"

\u2022 new IngressApi(opts?)

"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_1","title":"Parameters","text":"Name Type opts? DerivedKubeApiOptions & IgnoredKubeApiOptions"},{"location":"extensions/api/modules/Main.K8sApi/#kubeapi_1","title":"KubeApi","text":"

\u2022 KubeApi: <Object_1, Data>(opts: KubeApiOptions<Object_1, Data> & ExternalKubeApiOptions) => KubeApi<Object_1, Data>

"},{"location":"extensions/api/modules/Main.K8sApi/#type-declaration_2","title":"Type declaration","text":"

\u2022 new KubeApi<Object_1, Data>(opts)

"},{"location":"extensions/api/modules/Main.K8sApi/#type-parameters_4","title":"Type parameters","text":"Name Type Object_1 extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Object_1> = KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> Data extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Data> = KubeJsonApiDataFor<Object_1>"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_2","title":"Parameters","text":"Name Type opts KubeApiOptions<Object_1, Data> & ExternalKubeApiOptions"},{"location":"extensions/api/modules/Main.K8sApi/#kubejsonapi_1","title":"KubeJsonApi","text":"

\u2022 KubeJsonApi: (config: JsonApiConfig, reqInit?: RequestInit) => KubeJsonApi & { forCluster: CreateKubeJsonApiForCluster }

"},{"location":"extensions/api/modules/Main.K8sApi/#nodesapi_1","title":"NodesApi","text":"

\u2022 NodesApi: (opts?: DerivedKubeApiOptions & IgnoredKubeApiOptions) => NodeApi

"},{"location":"extensions/api/modules/Main.K8sApi/#type-declaration_3","title":"Type declaration","text":"

\u2022 new NodesApi(opts?)

"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_3","title":"Parameters","text":"Name Type opts? DerivedKubeApiOptions & IgnoredKubeApiOptions"},{"location":"extensions/api/modules/Main.K8sApi/#persistentvolumeclaimsapi_1","title":"PersistentVolumeClaimsApi","text":"

\u2022 PersistentVolumeClaimsApi: (opts?: DerivedKubeApiOptions & IgnoredKubeApiOptions) => PersistentVolumeClaimApi

"},{"location":"extensions/api/modules/Main.K8sApi/#type-declaration_4","title":"Type declaration","text":"

\u2022 new PersistentVolumeClaimsApi(opts?)

"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_4","title":"Parameters","text":"Name Type opts? DerivedKubeApiOptions & IgnoredKubeApiOptions"},{"location":"extensions/api/modules/Main.K8sApi/#podsapi_1","title":"PodsApi","text":"

\u2022 PodsApi: (opts?: DerivedKubeApiOptions & IgnoredKubeApiOptions) => PodApi

"},{"location":"extensions/api/modules/Main.K8sApi/#type-declaration_5","title":"Type declaration","text":"

\u2022 new PodsApi(opts?)

"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_5","title":"Parameters","text":"Name Type opts? DerivedKubeApiOptions & IgnoredKubeApiOptions"},{"location":"extensions/api/modules/Main.K8sApi/#apimanager","title":"apiManager","text":"

\u2022 Const apiManager: ApiManager

"},{"location":"extensions/api/modules/Main.K8sApi/#functions_1","title":"Functions","text":""},{"location":"extensions/api/modules/Main.K8sApi/#createresourcestack","title":"createResourceStack","text":"

\u25b8 createResourceStack(cluster, name): ResourceApplyingStack

"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_6","title":"Parameters","text":"Name Type cluster KubernetesCluster<KubernetesClusterMetadata, KubernetesClusterStatus, KubernetesClusterSpec> name string"},{"location":"extensions/api/modules/Main.K8sApi/#returns","title":"Returns","text":"

ResourceApplyingStack

"},{"location":"extensions/api/modules/Main.K8sApi/#forcluster","title":"forCluster","text":"

\u25b8 forCluster<Object, Api, Data>(cluster, kubeClass, apiClass): Api

"},{"location":"extensions/api/modules/Main.K8sApi/#type-parameters_5","title":"Type parameters","text":"Name Type Object extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Object> Api extends KubeApi<Object, KubeJsonApiDataFor<Object>, Api> Data extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Data>"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_7","title":"Parameters","text":"Name Type cluster ILocalKubeApiConfig kubeClass KubeObjectConstructor<Object, Data> apiClass KubeApiConstructor<Object, Api>"},{"location":"extensions/api/modules/Main.K8sApi/#returns_1","title":"Returns","text":"

Api

\u25b8 forCluster<Object, Data>(cluster, kubeClass, apiClass?): KubeApi<Object, KubeJsonApiDataFor<Object>>

"},{"location":"extensions/api/modules/Main.K8sApi/#type-parameters_6","title":"Type parameters","text":"Name Type Object extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Object> Data extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Data>"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_8","title":"Parameters","text":"Name Type cluster ILocalKubeApiConfig kubeClass KubeObjectConstructor<Object, Data> apiClass? KubeApiConstructor<Object, KubeApi<Object, KubeJsonApiDataFor<Object>>>"},{"location":"extensions/api/modules/Main.K8sApi/#returns_2","title":"Returns","text":"

KubeApi<Object, KubeJsonApiDataFor<Object>>

"},{"location":"extensions/api/modules/Main.K8sApi/#forremotecluster","title":"forRemoteCluster","text":"

\u25b8 forRemoteCluster<Object, Api, Data>(config, kubeClass, apiClass): Api

"},{"location":"extensions/api/modules/Main.K8sApi/#type-parameters_7","title":"Type parameters","text":"Name Type Object extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Object> Api extends KubeApi<Object, KubeJsonApiDataFor<Object>, Api> Data extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Data>"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_9","title":"Parameters","text":"Name Type config IRemoteKubeApiConfig kubeClass KubeObjectConstructor<Object, Data> apiClass KubeApiConstructor<Object, Api>"},{"location":"extensions/api/modules/Main.K8sApi/#returns_3","title":"Returns","text":"

Api

\u25b8 forRemoteCluster<Object, Data>(config, kubeClass, apiClass?): KubeApi<Object, KubeJsonApiDataFor<Object>>

"},{"location":"extensions/api/modules/Main.K8sApi/#type-parameters_8","title":"Type parameters","text":"Name Type Object extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Object> Data extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Data>"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_10","title":"Parameters","text":"Name Type config IRemoteKubeApiConfig kubeClass KubeObjectConstructor<Object, Data> apiClass? KubeApiConstructor<Object, KubeApi<Object, KubeJsonApiDataFor<Object>>>"},{"location":"extensions/api/modules/Main.K8sApi/#returns_4","title":"Returns","text":"

KubeApi<Object, KubeJsonApiDataFor<Object>>

"},{"location":"extensions/api/modules/Main.K8sApi/#getpodsbyownerid","title":"getPodsByOwnerId","text":"

\u25b8 getPodsByOwnerId(ownerId): Pod[]

"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_11","title":"Parameters","text":"Name Type ownerId string"},{"location":"extensions/api/modules/Main.K8sApi/#returns_5","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/modules/Main.K8sApi/#isallowedresource","title":"isAllowedResource","text":"

\u25b8 isAllowedResource(...args): boolean

Deprecated

This function never works

"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_12","title":"Parameters","text":"Name Type ...args any[]"},{"location":"extensions/api/modules/Main.K8sApi/#returns_6","title":"Returns","text":"

boolean

false

"},{"location":"extensions/api/modules/Main.K8sApi/#iskubestatusdata","title":"isKubeStatusData","text":"

\u25b8 isKubeStatusData(object): object is KubeStatusData

Is the shape of object correct for KubeStatusData

"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_13","title":"Parameters","text":"Name Type Description object unknown Some object"},{"location":"extensions/api/modules/Main.K8sApi/#returns_7","title":"Returns","text":"

object is KubeStatusData

"},{"location":"extensions/api/modules/Main.Navigation/","title":"Main.Navigation","text":"

@k8slens/extensions / Exports / Main / Navigation

"},{"location":"extensions/api/modules/Main.Navigation/#namespace-navigation","title":"Namespace: Navigation","text":"

Main.Navigation

"},{"location":"extensions/api/modules/Main.Navigation/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Main.Navigation/#functions","title":"Functions","text":"
  • navigate
"},{"location":"extensions/api/modules/Main.Navigation/#functions_1","title":"Functions","text":""},{"location":"extensions/api/modules/Main.Navigation/#navigate","title":"navigate","text":"

\u25b8 navigate(url): Promise<void>

Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.

"},{"location":"extensions/api/modules/Main.Navigation/#parameters","title":"Parameters","text":"Name Type url string"},{"location":"extensions/api/modules/Main.Navigation/#returns","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/modules/Main.Power/","title":"Main.Power","text":"

@k8slens/extensions / Exports / Main / Power

"},{"location":"extensions/api/modules/Main.Power/#namespace-power","title":"Namespace: Power","text":"

Main.Power

"},{"location":"extensions/api/modules/Main.Power/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Main.Power/#type-aliases","title":"Type Aliases","text":"
  • PowerEventListener
"},{"location":"extensions/api/modules/Main.Power/#functions","title":"Functions","text":"
  • onResume
  • onShutdown
  • onSuspend
"},{"location":"extensions/api/modules/Main.Power/#type-aliases_1","title":"Type Aliases","text":""},{"location":"extensions/api/modules/Main.Power/#powereventlistener","title":"PowerEventListener","text":"

\u01ac PowerEventListener: () => void

"},{"location":"extensions/api/modules/Main.Power/#type-declaration","title":"Type declaration","text":"

\u25b8 (): void

Event listener for system power events

"},{"location":"extensions/api/modules/Main.Power/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/modules/Main.Power/#functions_1","title":"Functions","text":""},{"location":"extensions/api/modules/Main.Power/#onresume","title":"onResume","text":"

\u25b8 onResume(listener): Disposer

Adds event listener to system resume event

"},{"location":"extensions/api/modules/Main.Power/#parameters","title":"Parameters","text":"Name Type Description listener PowerEventListener function which will be called on system resume"},{"location":"extensions/api/modules/Main.Power/#returns_1","title":"Returns","text":"

Disposer

function to remove event listener

"},{"location":"extensions/api/modules/Main.Power/#onshutdown","title":"onShutdown","text":"

\u25b8 onShutdown(listener): Disposer

Adds event listener to the event which is emitted when the system is about to reboot or shut down

"},{"location":"extensions/api/modules/Main.Power/#parameters_1","title":"Parameters","text":"Name Type Description listener PowerEventListener function which will be called on system shutdown"},{"location":"extensions/api/modules/Main.Power/#returns_2","title":"Returns","text":"

Disposer

function to remove event listener

"},{"location":"extensions/api/modules/Main.Power/#onsuspend","title":"onSuspend","text":"

\u25b8 onSuspend(listener): Disposer

Adds event listener to system suspend events

"},{"location":"extensions/api/modules/Main.Power/#parameters_2","title":"Parameters","text":"Name Type Description listener PowerEventListener function which will be called on system suspend"},{"location":"extensions/api/modules/Main.Power/#returns_3","title":"Returns","text":"

Disposer

function to remove event listener

"},{"location":"extensions/api/modules/Main/","title":"Main","text":"

@k8slens/extensions / Exports / Main

"},{"location":"extensions/api/modules/Main/#namespace-main","title":"Namespace: Main","text":"

Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.

"},{"location":"extensions/api/modules/Main/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Main/#namespaces","title":"Namespaces","text":"
  • Catalog
  • K8sApi
  • Navigation
  • Power
"},{"location":"extensions/api/modules/Main/#classes","title":"Classes","text":"
  • Ipc
  • LensExtension
"},{"location":"extensions/api/modules/Renderer.Catalog/","title":"Renderer.Catalog","text":"

@k8slens/extensions / Exports / Renderer / Catalog

"},{"location":"extensions/api/modules/Renderer.Catalog/#namespace-catalog","title":"Namespace: Catalog","text":"

Renderer.Catalog

"},{"location":"extensions/api/modules/Renderer.Catalog/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Renderer.Catalog/#classes","title":"Classes","text":"
  • CatalogEntityRegistry
"},{"location":"extensions/api/modules/Renderer.Catalog/#variables","title":"Variables","text":"
  • activeCluster
  • catalogCategories
  • catalogEntities
"},{"location":"extensions/api/modules/Renderer.Catalog/#variables_1","title":"Variables","text":""},{"location":"extensions/api/modules/Renderer.Catalog/#activecluster","title":"activeCluster","text":"

\u2022 Const activeCluster: IComputedValue

"},{"location":"extensions/api/modules/Renderer.Catalog/#catalogcategories","title":"catalogCategories","text":"

\u2022 Const catalogCategories: CatalogCategoryRegistry

"},{"location":"extensions/api/modules/Renderer.Catalog/#catalogentities","title":"catalogEntities","text":"

\u2022 Const catalogEntities: CatalogEntityRegistry

"},{"location":"extensions/api/modules/Renderer.Component/","title":"Renderer.Component","text":"

@k8slens/extensions / Exports / Renderer / Component

"},{"location":"extensions/api/modules/Renderer.Component/#namespace-component","title":"Namespace: Component","text":"

Renderer.Component

"},{"location":"extensions/api/modules/Renderer.Component/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Renderer.Component/#references","title":"References","text":"
  • CategoryColumnRegistration
"},{"location":"extensions/api/modules/Renderer.Component/#enumerations","title":"Enumerations","text":"
  • NotificationStatus
  • TooltipPosition
"},{"location":"extensions/api/modules/Renderer.Component/#classes","title":"Classes","text":"
  • DrawerParamToggler
  • Input
  • MenuItem
  • NotificationsStore
  • PageLayout
  • SettingLayout
  • Slider
  • Spinner
  • Stepper
  • SubTitle
  • Tab
  • TableCell
  • TableHead
  • TableRow
  • Tabs
  • TerminalStore
  • Wizard
  • WizardLayout
  • WizardStep
"},{"location":"extensions/api/modules/Renderer.Component/#interfaces","title":"Interfaces","text":"
  • AdditionalCategoryColumnRegistration
  • BadgeProps
  • BarChartProps
  • BaseIconProps
  • ButtonProps
  • CheckboxProps
  • ConfirmDialogBooleanParams
  • ConfirmDialogParams
  • ConfirmDialogProps
  • CreateNotificationOptions
  • CustomPlaceholderProps
  • DialogProps
  • DrawerItemLabelsProps
  • DrawerItemProps
  • DrawerParamTogglerProps
  • DrawerProps
  • DrawerTitleProps
  • IconDataFnArg
  • IconProps
  • KubeEventDetailsProps
  • KubeObjectDetailsProps
  • KubeObjectListLayoutProps
  • KubeObjectMenuProps
  • KubeObjectMetaProps
  • LineProgressProps
  • MainLayoutProps
  • MenuActionsProps
  • MenuContextValue
  • MenuItemProps
  • MenuPosition
  • MenuProps
  • MenuStyle
  • MonacoEditorProps
  • NamespaceSelectProps
  • Notification
  • PieChartData
  • PieChartProps
  • PodDetailsListProps
  • RadioGroupProps
  • RadioProps
  • ResourceMetricsProps
  • ResourceMetricsValue
  • SearchInputProps
  • SelectOption
  • SelectProps
  • SettingLayoutProps
  • SliderProps
  • SpinnerProps
  • StatusBrickProps
  • StepperProps
  • SubTitleProps
  • SwitchProps
  • SwitcherProps
  • TabLayoutProps
  • TabLayoutRoute
  • TabProps
  • TableCellProps
  • TableHeadProps
  • TableProps
  • TableRowProps
  • TableSortParams
  • TabsProps
  • TooltipContentFormatters
  • TooltipDecoratorProps
  • TooltipProps
  • WizardCommonProps
  • WizardLayoutProps
  • WizardProps
  • WizardStepProps
"},{"location":"extensions/api/modules/Renderer.Component/#type-aliases","title":"Type Aliases","text":"
  • AtLeastOneMetricTab
  • DatasetTooltipLabel
  • DrawerPosition
  • IconData
  • InputProps
  • InputValidation
  • InputValidationResult
  • InputValidator
  • KubeItemListStore
  • LegacyAutoConvertedOptions
  • MonacoCustomTheme
  • MonacoEditorId
  • MonacoTheme
  • NamedSvg
  • NamespaceSelectSort
  • NotificationId
  • NotificationMessage
  • ShowNotification
  • SyncValidationMessage
  • TableCellElem
  • TableHeadElem
  • TableOrderBy
  • TableRowElem
  • TableSortBy
  • TableSortCallback
  • TableSortCallbacks
"},{"location":"extensions/api/modules/Renderer.Component/#variables","title":"Variables","text":"
  • CommandOverlay
  • InputValidators
  • MenuContext
  • Notifications
  • ResourceMetricsContext
  • Tooltip
  • cpuOptions
  • logTabStore
  • memoryOptions
  • notificationsStore
  • podMetricTabs
  • resizingAnchorProps
  • terminalStore
"},{"location":"extensions/api/modules/Renderer.Component/#functions","title":"Functions","text":"
  • Badge
  • BarChart
  • Button
  • Checkbox
  • ConfirmDialog
  • Dialog
  • Drawer
  • DrawerItem
  • DrawerItemLabels
  • DrawerTitle
  • FormSwitch
  • Icon
  • KubeEventDetails
  • KubeObjectDetails
  • KubeObjectListLayout
  • KubeObjectMenu
  • KubeObjectMeta
  • LineProgress
  • MainLayout
  • Menu
  • MenuActions
  • MonacoEditor
  • NamespaceSelect
  • NamespaceSelectFilter
  • PieChart
  • PodCharts
  • PodDetailsList
  • Radio
  • RadioGroup
  • ResourceMetrics
  • SearchInput
  • Select
  • StatusBrick
  • SubMenu
  • Switch
  • Switcher
  • TabLayout
  • Table
  • asyncInputValidator
  • createTerminalTab
  • getDetailsUrl
  • inputValidator
  • isAsyncValidator
  • isSvg
  • onMultiSelectFor
  • showDetails
  • unionInputValidatorsAsync
  • withTooltip
"},{"location":"extensions/api/modules/Renderer.Component/#references_1","title":"References","text":""},{"location":"extensions/api/modules/Renderer.Component/#categorycolumnregistration","title":"CategoryColumnRegistration","text":"

Re-exports CategoryColumnRegistration

"},{"location":"extensions/api/modules/Renderer.Component/#type-aliases_1","title":"Type Aliases","text":""},{"location":"extensions/api/modules/Renderer.Component/#atleastonemetrictab","title":"AtLeastOneMetricTab","text":"

\u01ac AtLeastOneMetricTab: [MetricsTab, ...MetricsTab[]]

"},{"location":"extensions/api/modules/Renderer.Component/#datasettooltiplabel","title":"DatasetTooltipLabel","text":"

\u01ac DatasetTooltipLabel: (percent: string) => string | string

"},{"location":"extensions/api/modules/Renderer.Component/#type-declaration","title":"Type declaration","text":"

\u25b8 (percent): string | string

"},{"location":"extensions/api/modules/Renderer.Component/#parameters","title":"Parameters","text":"Name Type percent string"},{"location":"extensions/api/modules/Renderer.Component/#returns","title":"Returns","text":"

string | string

"},{"location":"extensions/api/modules/Renderer.Component/#drawerposition","title":"DrawerPosition","text":"

\u01ac DrawerPosition: \"top\" | \"left\" | \"right\" | \"bottom\"

"},{"location":"extensions/api/modules/Renderer.Component/#icondata","title":"IconData","text":"

\u01ac IconData: string | React.ReactNode | (opt: IconDataFnArg) => React.ReactNode

One of the folloing: - A material icon name - A react node - Or a function that produces a react node

"},{"location":"extensions/api/modules/Renderer.Component/#inputprops","title":"InputProps","text":"

\u01ac InputProps: Omit<InputElementProps, \"onChange\" | \"onSubmit\"> & { autoSelectOnFocus?: boolean ; blurOnEnter?: boolean ; className?: string ; contentRight?: string | React.ReactNode ; defaultValue?: string ; dirty?: boolean ; iconLeft?: IconData ; iconRight?: IconData ; maxRows?: number ; multiLine?: boolean ; showErrorsAsTooltip?: boolean | Omit<TooltipProps, \"targetId\"> ; showValidationLine?: boolean ; theme?: \"round-black\" | \"round\" ; trim?: boolean ; validators?: SingleOrMany<InputValidator> ; value?: string ; onChange?: (value: string, evt: ChangeEvent<InputElement>) => void ; onSubmit?: (value: string, evt: KeyboardEvent<InputElement>) => void }

"},{"location":"extensions/api/modules/Renderer.Component/#inputvalidation","title":"InputValidation","text":"

\u01ac InputValidation<IsAsync>: (value: string, props?: InputProps) => InputValidationResult<IsAsync>

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters","title":"Type parameters","text":"Name Type IsAsync extends boolean"},{"location":"extensions/api/modules/Renderer.Component/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (value, props?): InputValidationResult<IsAsync>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_1","title":"Parameters","text":"Name Type value string props? InputProps"},{"location":"extensions/api/modules/Renderer.Component/#returns_1","title":"Returns","text":"

InputValidationResult<IsAsync>

"},{"location":"extensions/api/modules/Renderer.Component/#inputvalidationresult","title":"InputValidationResult","text":"

\u01ac InputValidationResult<IsAsync>: IsAsync extends true ? Promise<void> : boolean

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_1","title":"Type parameters","text":"Name Type IsAsync extends boolean"},{"location":"extensions/api/modules/Renderer.Component/#inputvalidator","title":"InputValidator","text":"

\u01ac InputValidator<IsAsync>: SyncInputValidator | AsyncInputValidator | IsAsync extends boolean ? LegacyInputValidator : never

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_2","title":"Type parameters","text":"Name Type IsAsync extends boolean = boolean"},{"location":"extensions/api/modules/Renderer.Component/#kubeitemliststore","title":"KubeItemListStore","text":"

\u01ac KubeItemListStore<K>: ItemListStore<K, false> & SubscribableStore & { contextItems: K[] ; getByPath: (path: string) => K | undefined }

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_3","title":"Type parameters","text":"Name Type K extends KubeObject"},{"location":"extensions/api/modules/Renderer.Component/#legacyautoconvertedoptions","title":"LegacyAutoConvertedOptions","text":"

\u01ac LegacyAutoConvertedOptions: string[]

Deprecated

This should not be used anymore, convert the options yourself.

"},{"location":"extensions/api/modules/Renderer.Component/#monacocustomtheme","title":"MonacoCustomTheme","text":"

\u01ac MonacoCustomTheme: \"clouds-midnight\"

"},{"location":"extensions/api/modules/Renderer.Component/#monacoeditorid","title":"MonacoEditorId","text":"

\u01ac MonacoEditorId: string

"},{"location":"extensions/api/modules/Renderer.Component/#monacotheme","title":"MonacoTheme","text":"

\u01ac MonacoTheme: \"vs\" | \"vs-dark\" | \"hc-black\" | MonacoCustomTheme

"},{"location":"extensions/api/modules/Renderer.Component/#namedsvg","title":"NamedSvg","text":"

\u01ac NamedSvg: \"configuration\" | \"crane\" | \"group\" | \"helm\" | \"install\" | \"kube\" | \"lens-logo\" | \"license\" | \"logo-lens\" | \"logout\" | \"nodes\" | \"push_off\" | \"push_pin\" | \"spinner\" | \"ssh\" | \"storage\" | \"terminal\" | \"user\" | \"users\" | \"wheel\" | \"workloads\"

"},{"location":"extensions/api/modules/Renderer.Component/#namespaceselectsort","title":"NamespaceSelectSort","text":"

\u01ac NamespaceSelectSort: (left: string, right: string) => number

"},{"location":"extensions/api/modules/Renderer.Component/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (left, right): number

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_2","title":"Parameters","text":"Name Type left string right string"},{"location":"extensions/api/modules/Renderer.Component/#returns_2","title":"Returns","text":"

number

"},{"location":"extensions/api/modules/Renderer.Component/#notificationid","title":"NotificationId","text":"

\u01ac NotificationId: string | number

"},{"location":"extensions/api/modules/Renderer.Component/#notificationmessage","title":"NotificationMessage","text":"

\u01ac NotificationMessage: string | React.ReactElement | React.ReactElement[] | JsonApiErrorParsed | Error

"},{"location":"extensions/api/modules/Renderer.Component/#shownotification","title":"ShowNotification","text":"

\u01ac ShowNotification: (message: NotificationMessage, opts?: CreateNotificationOptions) => Disposer

"},{"location":"extensions/api/modules/Renderer.Component/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (message, opts?): Disposer

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_3","title":"Parameters","text":"Name Type message NotificationMessage opts? CreateNotificationOptions"},{"location":"extensions/api/modules/Renderer.Component/#returns_3","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/modules/Renderer.Component/#syncvalidationmessage","title":"SyncValidationMessage","text":"

\u01ac SyncValidationMessage: React.ReactNode | (value: string, props?: InputProps) => React.ReactNode

"},{"location":"extensions/api/modules/Renderer.Component/#tablecellelem","title":"TableCellElem","text":"

\u01ac TableCellElem: React.ReactElement<TableCellProps>

"},{"location":"extensions/api/modules/Renderer.Component/#tableheadelem","title":"TableHeadElem","text":"

\u01ac TableHeadElem: React.ReactElement<TableHeadProps>

"},{"location":"extensions/api/modules/Renderer.Component/#tableorderby","title":"TableOrderBy","text":"

\u01ac TableOrderBy: \"asc\" | \"desc\"

"},{"location":"extensions/api/modules/Renderer.Component/#tablerowelem","title":"TableRowElem","text":"

\u01ac TableRowElem<Item>: React.ReactElement<TableRowProps<Item>>

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_4","title":"Type parameters","text":"Name Item"},{"location":"extensions/api/modules/Renderer.Component/#tablesortby","title":"TableSortBy","text":"

\u01ac TableSortBy: string

"},{"location":"extensions/api/modules/Renderer.Component/#tablesortcallback","title":"TableSortCallback","text":"

\u01ac TableSortCallback<Item>: (data: Item) => undefined | string | number | (string | number)[]

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_5","title":"Type parameters","text":"Name Item"},{"location":"extensions/api/modules/Renderer.Component/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (data): undefined | string | number | (string | number)[]

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_4","title":"Parameters","text":"Name Type data Item"},{"location":"extensions/api/modules/Renderer.Component/#returns_4","title":"Returns","text":"

undefined | string | number | (string | number)[]

"},{"location":"extensions/api/modules/Renderer.Component/#tablesortcallbacks","title":"TableSortCallbacks","text":"

\u01ac TableSortCallbacks<Item>: Record<string, TableSortCallback<Item>>

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_6","title":"Type parameters","text":"Name Item"},{"location":"extensions/api/modules/Renderer.Component/#variables_1","title":"Variables","text":""},{"location":"extensions/api/modules/Renderer.Component/#commandoverlay","title":"CommandOverlay","text":"

\u2022 Const CommandOverlay: CommandOverlay

"},{"location":"extensions/api/modules/Renderer.Component/#inputvalidators","title":"InputValidators","text":"

\u2022 Const InputValidators: Object

"},{"location":"extensions/api/modules/Renderer.Component/#type-declaration_5","title":"Type declaration","text":"Name Type accountId Validators.SyncInputValidator isEmail Validators.SyncInputValidator isExtensionNameInstall Validators.SyncInputValidator isExtensionNameInstallRegex { captures: (val: string) => undefined | { name: string ; version?: string } ; isMatch: (val: string) => boolean } isExtensionNameInstallRegex.captures [object Object] isExtensionNameInstallRegex.isMatch [object Object] isNumber Validators.SyncInputValidator isPath Validators.AsyncInputValidator isRequired Validators.SyncInputValidator isUrl Validators.SyncInputValidator maxLength Validators.SyncInputValidator minLength Validators.SyncInputValidator systemName Validators.SyncInputValidator unionInputValidators (baseValidator: Pick<SyncInputValidator, \"message\" | \"condition\">, ...validators: SyncInputValidator[]) => SyncInputValidator"},{"location":"extensions/api/modules/Renderer.Component/#menucontext","title":"MenuContext","text":"

\u2022 Const MenuContext: React.Context<MenuContextValue | null>

"},{"location":"extensions/api/modules/Renderer.Component/#notifications","title":"Notifications","text":"

\u2022 Const Notifications: Object

"},{"location":"extensions/api/modules/Renderer.Component/#type-declaration_6","title":"Type declaration","text":"Name Type checkedError ShowCheckedErrorNotification error ShowNotification info ShowNotification ok ShowNotification shortInfo ShowNotification"},{"location":"extensions/api/modules/Renderer.Component/#resourcemetricscontext","title":"ResourceMetricsContext","text":"

\u2022 Const ResourceMetricsContext: React.Context<ResourceMetricsValue | null>

"},{"location":"extensions/api/modules/Renderer.Component/#tooltip","title":"Tooltip","text":"

\u2022 Const Tooltip: React.ComponentClass<TooltipProps, any>

"},{"location":"extensions/api/modules/Renderer.Component/#cpuoptions","title":"cpuOptions","text":"

\u2022 Const cpuOptions: ChartOptions

"},{"location":"extensions/api/modules/Renderer.Component/#logtabstore","title":"logTabStore","text":"

\u2022 Const logTabStore: LogTabStore & { createPodTab: ({ selectedPod, selectedContainer }: PodLogsTabData) => string ; createWorkloadTab: ({ workload }: WorkloadLogsTabData) => string | undefined ; renameTab: (tabId: string) => void ; tabs: undefined }

"},{"location":"extensions/api/modules/Renderer.Component/#memoryoptions","title":"memoryOptions","text":"

\u2022 Const memoryOptions: ChartOptions

"},{"location":"extensions/api/modules/Renderer.Component/#notificationsstore","title":"notificationsStore","text":"

\u2022 Const notificationsStore: NotificationsStore

"},{"location":"extensions/api/modules/Renderer.Component/#podmetrictabs","title":"podMetricTabs","text":"

\u2022 Const podMetricTabs: AtLeastOneMetricTab

"},{"location":"extensions/api/modules/Renderer.Component/#resizinganchorprops","title":"resizingAnchorProps","text":"

\u2022 Const resizingAnchorProps: Record<DrawerPosition, [ResizeDirection, ResizeSide, ResizeGrowthDirection]>

"},{"location":"extensions/api/modules/Renderer.Component/#terminalstore","title":"terminalStore","text":"

\u2022 Const terminalStore: TerminalStore & { sendCommand: SendCommand }

"},{"location":"extensions/api/modules/Renderer.Component/#functions_1","title":"Functions","text":""},{"location":"extensions/api/modules/Renderer.Component/#badge","title":"Badge","text":"

\u25b8 Badge(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_5","title":"Parameters","text":"Name Type props PropsWithChildren<BadgeProps & TooltipDecoratorProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_5","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#barchart","title":"BarChart","text":"

\u25b8 BarChart(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_6","title":"Parameters","text":"Name Type props PropsWithChildren<BarChartProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_6","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#button","title":"Button","text":"

\u25b8 Button(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_7","title":"Parameters","text":"Name Type props PropsWithChildren<ButtonProps & TooltipDecoratorProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_7","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#checkbox","title":"Checkbox","text":"

\u25b8 Checkbox(\u00abdestructured\u00bb): JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_8","title":"Parameters","text":"Name Type \u00abdestructured\u00bb CheckboxProps"},{"location":"extensions/api/modules/Renderer.Component/#returns_8","title":"Returns","text":"

JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#confirmdialog","title":"ConfirmDialog","text":"

\u25b8 ConfirmDialog(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_9","title":"Parameters","text":"Name Type props PropsWithChildren<ConfirmDialogProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_9","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#dialog","title":"Dialog","text":"

\u25b8 Dialog(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_10","title":"Parameters","text":"Name Type props PropsWithChildren<DialogProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_10","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#drawer","title":"Drawer","text":"

\u25b8 Drawer(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_11","title":"Parameters","text":"Name Type props PropsWithChildren<DrawerProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_11","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#draweritem","title":"DrawerItem","text":"

\u25b8 DrawerItem(\u00abdestructured\u00bb): JSX.Element | null

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_12","title":"Parameters","text":"Name Type \u00abdestructured\u00bb DrawerItemProps"},{"location":"extensions/api/modules/Renderer.Component/#returns_12","title":"Returns","text":"

JSX.Element | null

"},{"location":"extensions/api/modules/Renderer.Component/#draweritemlabels","title":"DrawerItemLabels","text":"

\u25b8 DrawerItemLabels(props): JSX.Element | null

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_13","title":"Parameters","text":"Name Type props DrawerItemLabelsProps"},{"location":"extensions/api/modules/Renderer.Component/#returns_13","title":"Returns","text":"

JSX.Element | null

"},{"location":"extensions/api/modules/Renderer.Component/#drawertitle","title":"DrawerTitle","text":"

\u25b8 DrawerTitle(\u00abdestructured\u00bb): JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_14","title":"Parameters","text":"Name Type \u00abdestructured\u00bb DrawerTitleProps"},{"location":"extensions/api/modules/Renderer.Component/#returns_14","title":"Returns","text":"

JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#formswitch","title":"FormSwitch","text":"

\u25b8 FormSwitch(props): React.FunctionComponentElement<any>

Deprecated

Use instead from \"../switch.tsx\".

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_15","title":"Parameters","text":"Name Type props FormControlLabelProps & { children?: ReactNode }"},{"location":"extensions/api/modules/Renderer.Component/#returns_15","title":"Returns","text":"

React.FunctionComponentElement<any>

"},{"location":"extensions/api/modules/Renderer.Component/#icon","title":"Icon","text":"

\u25b8 Icon(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_16","title":"Parameters","text":"Name Type props PropsWithChildren<IconProps & TooltipDecoratorProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_16","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#kubeeventdetails","title":"KubeEventDetails","text":"

\u25b8 KubeEventDetails(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_17","title":"Parameters","text":"Name Type props PropsWithChildren<KubeEventDetailsProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_17","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#kubeobjectdetails","title":"KubeObjectDetails","text":"

\u25b8 KubeObjectDetails(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_18","title":"Parameters","text":"Name Type props Object context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_18","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#kubeobjectlistlayout","title":"KubeObjectListLayout","text":"

\u25b8 KubeObjectListLayout<K, A, D>(props): ReactElement<any, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_7","title":"Type parameters","text":"Name Type K extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, K> A extends KubeApi<K, D, A> D extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, D> = KubeJsonApiDataFor<K>"},{"location":"extensions/api/modules/Renderer.Component/#parameters_19","title":"Parameters","text":"Name Type props KubeObjectListLayoutProps<K, A, D>"},{"location":"extensions/api/modules/Renderer.Component/#returns_19","title":"Returns","text":"

ReactElement<any, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/modules/Renderer.Component/#kubeobjectmenu","title":"KubeObjectMenu","text":"

\u25b8 KubeObjectMenu<T>(props): ReactElement<any, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_8","title":"Type parameters","text":"Name Type T extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, T>"},{"location":"extensions/api/modules/Renderer.Component/#parameters_20","title":"Parameters","text":"Name Type props KubeObjectMenuProps<T>"},{"location":"extensions/api/modules/Renderer.Component/#returns_20","title":"Returns","text":"

ReactElement<any, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/modules/Renderer.Component/#kubeobjectmeta","title":"KubeObjectMeta","text":"

\u25b8 KubeObjectMeta(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_21","title":"Parameters","text":"Name Type props PropsWithChildren<KubeObjectMetaProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_21","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#lineprogress","title":"LineProgress","text":"

\u25b8 LineProgress(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_22","title":"Parameters","text":"Name Type props PropsWithChildren<LineProgressProps & TooltipDecoratorProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_22","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#mainlayout","title":"MainLayout","text":"

\u25b8 MainLayout(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_23","title":"Parameters","text":"Name Type props PropsWithChildren<MainLayoutProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_23","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#menu","title":"Menu","text":"

\u25b8 Menu(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_24","title":"Parameters","text":"Name Type props PropsWithChildren<MenuProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_24","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#menuactions","title":"MenuActions","text":"

\u25b8 MenuActions(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_25","title":"Parameters","text":"Name Type props PropsWithChildren<MenuActionsProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_25","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#monacoeditor","title":"MonacoEditor","text":"

\u25b8 MonacoEditor(props): null | ReactElement<any, string | JSXElementConstructor<any>>

NOTE: Exotic components are not callable.

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_26","title":"Parameters","text":"Name Type props MonacoEditorProps & RefAttributes<MonacoEditorRef>"},{"location":"extensions/api/modules/Renderer.Component/#returns_26","title":"Returns","text":"

null | ReactElement<any, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/modules/Renderer.Component/#namespaceselect","title":"NamespaceSelect","text":"

\u25b8 NamespaceSelect<IsMulti>(props): JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_9","title":"Type parameters","text":"Name Type IsMulti extends boolean = false"},{"location":"extensions/api/modules/Renderer.Component/#parameters_27","title":"Parameters","text":"Name Type props NamespaceSelectProps<IsMulti>"},{"location":"extensions/api/modules/Renderer.Component/#returns_27","title":"Returns","text":"

JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#namespaceselectfilter","title":"NamespaceSelectFilter","text":"

\u25b8 NamespaceSelectFilter(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_28","title":"Parameters","text":"Name Type props PropsWithChildren<NamespaceSelectFilterProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_28","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#piechart","title":"PieChart","text":"

\u25b8 PieChart(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_29","title":"Parameters","text":"Name Type props PropsWithChildren<PieChartProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_29","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#podcharts","title":"PodCharts","text":"

\u25b8 PodCharts(): null | Element

"},{"location":"extensions/api/modules/Renderer.Component/#returns_30","title":"Returns","text":"

null | Element

"},{"location":"extensions/api/modules/Renderer.Component/#poddetailslist","title":"PodDetailsList","text":"

\u25b8 PodDetailsList(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_30","title":"Parameters","text":"Name Type props PropsWithChildren<PodDetailsListProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_31","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#radio","title":"Radio","text":"

\u25b8 Radio<T>(\u00abdestructured\u00bb): JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_10","title":"Type parameters","text":"Name T"},{"location":"extensions/api/modules/Renderer.Component/#parameters_31","title":"Parameters","text":"Name Type \u00abdestructured\u00bb RadioProps<T>"},{"location":"extensions/api/modules/Renderer.Component/#returns_32","title":"Returns","text":"

JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#radiogroup","title":"RadioGroup","text":"

\u25b8 RadioGroup<T>(\u00abdestructured\u00bb): JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_11","title":"Type parameters","text":"Name T"},{"location":"extensions/api/modules/Renderer.Component/#parameters_32","title":"Parameters","text":"Name Type \u00abdestructured\u00bb RadioGroupProps<T>"},{"location":"extensions/api/modules/Renderer.Component/#returns_33","title":"Returns","text":"

JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#resourcemetrics","title":"ResourceMetrics","text":"

\u25b8 ResourceMetrics<Keys>(\u00abdestructured\u00bb): Element

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_12","title":"Type parameters","text":"Name Type Keys extends string"},{"location":"extensions/api/modules/Renderer.Component/#parameters_33","title":"Parameters","text":"Name Type \u00abdestructured\u00bb ResourceMetricsProps<Keys>"},{"location":"extensions/api/modules/Renderer.Component/#returns_34","title":"Returns","text":"

Element

"},{"location":"extensions/api/modules/Renderer.Component/#searchinput","title":"SearchInput","text":"

\u25b8 SearchInput(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_34","title":"Parameters","text":"Name Type props PropsWithChildren<SearchInputProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_35","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#select","title":"Select","text":"

\u25b8 Select<Value, Option, IsMulti, Group>(props): ReactElement<any, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_13","title":"Type parameters","text":"Name Type Value Value Option extends SelectOption<Value, Option> IsMulti extends boolean = false Group extends GroupBase<Option, Group> = GroupBase<Option>"},{"location":"extensions/api/modules/Renderer.Component/#parameters_35","title":"Parameters","text":"Name Type props SelectProps<Value, Option, IsMulti, Group>"},{"location":"extensions/api/modules/Renderer.Component/#returns_36","title":"Returns","text":"

ReactElement<any, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/modules/Renderer.Component/#statusbrick","title":"StatusBrick","text":"

\u25b8 StatusBrick(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_36","title":"Parameters","text":"Name Type props PropsWithChildren<StatusBrickProps & TooltipDecoratorProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_37","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#submenu","title":"SubMenu","text":"

\u25b8 SubMenu(props): JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_37","title":"Parameters","text":"Name Type props Partial<MenuProps>"},{"location":"extensions/api/modules/Renderer.Component/#returns_38","title":"Returns","text":"

JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#switch","title":"Switch","text":"

\u25b8 Switch(\u00abdestructured\u00bb): JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_38","title":"Parameters","text":"Name Type \u00abdestructured\u00bb SwitchProps"},{"location":"extensions/api/modules/Renderer.Component/#returns_39","title":"Returns","text":"

JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#switcher","title":"Switcher","text":"

\u25b8 Switcher(\u00abdestructured\u00bb): JSX.Element

Deprecated

Use instead from \"../switch.tsx\".

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_39","title":"Parameters","text":"Name Type \u00abdestructured\u00bb SwitcherProps"},{"location":"extensions/api/modules/Renderer.Component/#returns_40","title":"Returns","text":"

JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#tablayout","title":"TabLayout","text":"

\u25b8 TabLayout(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_40","title":"Parameters","text":"Name Type props PropsWithChildren<TabLayoutProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_41","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#table","title":"Table","text":"

\u25b8 Table<Item>(props): ReactElement<any, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_14","title":"Type parameters","text":"Name Item"},{"location":"extensions/api/modules/Renderer.Component/#parameters_41","title":"Parameters","text":"Name Type props TableProps<Item>"},{"location":"extensions/api/modules/Renderer.Component/#returns_42","title":"Returns","text":"

ReactElement<any, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/modules/Renderer.Component/#asyncinputvalidator","title":"asyncInputValidator","text":"

\u25b8 asyncInputValidator(validator): AsyncInputValidator

A helper function to create an AsyncInputValidator

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_42","title":"Parameters","text":"Name Type validator AsyncInputValidator"},{"location":"extensions/api/modules/Renderer.Component/#returns_43","title":"Returns","text":"

AsyncInputValidator

"},{"location":"extensions/api/modules/Renderer.Component/#createterminaltab","title":"createTerminalTab","text":"

\u25b8 createTerminalTab(tabParams?): Required<DockTabCreate>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_43","title":"Parameters","text":"Name Type tabParams? DockTabCreateSpecific"},{"location":"extensions/api/modules/Renderer.Component/#returns_44","title":"Returns","text":"

Required<DockTabCreate>

"},{"location":"extensions/api/modules/Renderer.Component/#getdetailsurl","title":"getDetailsUrl","text":"

\u25b8 getDetailsUrl(selfLink, resetSelected?, mergeGlobals?): string

Deprecated

Use Renderer.Navigation.getDetailsUrl

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_44","title":"Parameters","text":"Name Type selfLink string resetSelected? boolean mergeGlobals? boolean"},{"location":"extensions/api/modules/Renderer.Component/#returns_45","title":"Returns","text":"

string

"},{"location":"extensions/api/modules/Renderer.Component/#inputvalidator_1","title":"inputValidator","text":"

\u25b8 inputValidator(validator): SyncInputValidator

A helper function to create an SyncInputValidator

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_45","title":"Parameters","text":"Name Type validator SyncInputValidator"},{"location":"extensions/api/modules/Renderer.Component/#returns_46","title":"Returns","text":"

SyncInputValidator

"},{"location":"extensions/api/modules/Renderer.Component/#isasyncvalidator","title":"isAsyncValidator","text":"

\u25b8 isAsyncValidator(validator): validator is AsyncInputValidator

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_46","title":"Parameters","text":"Name Type validator InputValidator<boolean>"},{"location":"extensions/api/modules/Renderer.Component/#returns_47","title":"Returns","text":"

validator is AsyncInputValidator

"},{"location":"extensions/api/modules/Renderer.Component/#issvg","title":"isSvg","text":"

\u25b8 isSvg(content): boolean

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_47","title":"Parameters","text":"Name Type content string"},{"location":"extensions/api/modules/Renderer.Component/#returns_48","title":"Returns","text":"

boolean

"},{"location":"extensions/api/modules/Renderer.Component/#onmultiselectfor","title":"onMultiSelectFor","text":"

\u25b8 onMultiSelectFor<Value, Option, Group>(collection): SelectProps<Value, Option, true, Group>[\"onChange\"]

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_15","title":"Type parameters","text":"Name Type Value Value Option extends SelectOption<Value, Option> Group extends GroupBase<Option, Group> = GroupBase<Option>"},{"location":"extensions/api/modules/Renderer.Component/#parameters_48","title":"Parameters","text":"Name Type collection Set<Value> | ObservableSet<Value>"},{"location":"extensions/api/modules/Renderer.Component/#returns_49","title":"Returns","text":"

SelectProps<Value, Option, true, Group>[\"onChange\"]

"},{"location":"extensions/api/modules/Renderer.Component/#showdetails","title":"showDetails","text":"

\u25b8 showDetails(selfLink, resetSelected?): void

Deprecated

Use Renderer.Navigation.showDetails

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_49","title":"Parameters","text":"Name Type selfLink undefined | string resetSelected? boolean"},{"location":"extensions/api/modules/Renderer.Component/#returns_50","title":"Returns","text":"

void

"},{"location":"extensions/api/modules/Renderer.Component/#unioninputvalidatorsasync","title":"unionInputValidatorsAsync","text":"

\u25b8 unionInputValidatorsAsync(baseValidator, ...validators): AsyncInputValidator

Create a new input validator from a list of syncronous or async input validators. Will match as valid if one of the input validators matches the input

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_50","title":"Parameters","text":"Name Type baseValidator Object baseValidator.condition undefined | (props: InputProps) => any | (props: InputProps) => any | (props: InputProps) => any baseValidator.message null | string | number | boolean | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | (value: string, props?: InputProps) => ReactNode ...validators InputValidator<boolean>[]"},{"location":"extensions/api/modules/Renderer.Component/#returns_51","title":"Returns","text":"

AsyncInputValidator

"},{"location":"extensions/api/modules/Renderer.Component/#withtooltip","title":"withTooltip","text":"

\u25b8 withTooltip<TargetProps>(Target): React.FunctionComponent<TargetProps & TooltipDecoratorProps>

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_16","title":"Type parameters","text":"Name TargetProps"},{"location":"extensions/api/modules/Renderer.Component/#parameters_51","title":"Parameters","text":"Name Type Target TargetProps extends Pick<TooltipDecoratorProps, \"id\" | \"children\"> ? FunctionComponent<TargetProps> : never"},{"location":"extensions/api/modules/Renderer.Component/#returns_52","title":"Returns","text":"

React.FunctionComponent<TargetProps & TooltipDecoratorProps>

"},{"location":"extensions/api/modules/Renderer.K8sApi/","title":"Renderer.K8sApi","text":"

@k8slens/extensions / Exports / Renderer / K8sApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#namespace-k8sapi","title":"Namespace: K8sApi","text":"

Renderer.K8sApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Renderer.K8sApi/#references","title":"References","text":"
  • BaseKubeJsonApiObjectMetadata
  • ClusterRole
  • ClusterRoleBinding
  • ClusterScopedMetadata
  • ConfigMap
  • CronJob
  • CustomResourceDefinition
  • DaemonSet
  • Deployment
  • DeploymentApi
  • Endpoint
  • ExternalKubeApiOptions
  • HorizontalPodAutoscaler
  • HorizontalPodAutoscalerStore
  • IKubeApiCluster
  • ILocalKubeApiConfig
  • IPodContainer
  • IPodContainerStatus
  • IRemoteKubeApiConfig
  • ISecretRef
  • IgnoredKubeApiOptions
  • Ingress
  • IngressApi
  • Job
  • JsonPatch
  • KubeApi
  • KubeEvent
  • KubeJsonApi
  • KubeJsonApiData
  • KubeJsonApiDataFor
  • KubeJsonApiObjectMetadata
  • KubeObject
  • KubeObjectMetadata
  • KubeObjectStore
  • KubeObjectStoreLoadAllParams
  • KubeObjectStoreLoadingParams
  • KubeObjectStoreSubscribeParams
  • KubeStatus
  • KubeStatusData
  • LimitRange
  • Namespace
  • NamespaceScopedMetadata
  • NetworkPolicy
  • Node
  • NodesApi
  • OwnerReference
  • PersistentVolume
  • PersistentVolumeClaim
  • PersistentVolumeClaimsApi
  • Pod
  • PodDisruptionBudget
  • PodsApi
  • PriorityClass
  • ReplicaSet
  • ResourceQuota
  • ResourceStack
  • Role
  • RoleBinding
  • Secret
  • Service
  • ServiceAccount
  • StatefulSet
  • StorageClass
  • apiManager
  • createKubeObject
  • createResourceStack
  • forCluster
  • forRemoteCluster
  • getPodsByOwnerId
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isKubeObjectNonSystem
  • isKubeStatusData
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • stringifyLabels
"},{"location":"extensions/api/modules/Renderer.K8sApi/#enumerations","title":"Enumerations","text":"
  • KubeObjectStatusLevel
"},{"location":"extensions/api/modules/Renderer.K8sApi/#classes","title":"Classes","text":"
  • CRDResourceStore
  • CRDStore
  • ConfigMapsStore
  • CronJobStore
  • DaemonSetStore
  • DeploymentStore
  • EndpointStore
  • EventStore
  • HPAStore
  • IngressClassStore
  • IngressStore
  • JobStore
  • LimitRangesStore
  • NamespaceStore
  • NetworkPolicyStore
  • NodesStore
  • PersistentVolumesStore
  • PodDisruptionBudgetsStore
  • PodsStore
  • PriorityClassStoreStore
  • ReplicaSetStore
  • ResourceQuotasStore
  • RoleBindingsStore
  • RolesStore
  • SecretsStore
  • ServiceAccountsStore
  • ServiceStore
  • StatefulSetStore
  • StorageClassStore
  • VerticalPodAutoscalerStore
  • VolumeClaimStore
"},{"location":"extensions/api/modules/Renderer.K8sApi/#interfaces","title":"Interfaces","text":"
  • KubeObjectStatus
  • MetricData
  • MetricResult
  • RequestMetricsParams
"},{"location":"extensions/api/modules/Renderer.K8sApi/#type-aliases","title":"Type Aliases","text":"
  • RequestMetrics
"},{"location":"extensions/api/modules/Renderer.K8sApi/#variables","title":"Variables","text":"
  • clusterRoleApi
  • clusterRoleBindingApi
  • configMapApi
  • crdApi
  • cronJobApi
  • daemonSetApi
  • deploymentApi
  • endpointApi
  • eventApi
  • hpaApi
  • ingressApi
  • jobApi
  • limitRangeApi
  • namespacesApi
  • networkPolicyApi
  • nodesApi
  • pcApi
  • pdbApi
  • persistentVolumeApi
  • podsApi
  • pvcApi
  • replicaSetApi
  • resourceQuotaApi
  • roleApi
  • roleBindingApi
  • secretsApi
  • serviceAccountsApi
  • serviceApi
  • statefulSetApi
  • storageClassApi
  • vpaApi
"},{"location":"extensions/api/modules/Renderer.K8sApi/#functions","title":"Functions","text":"
  • isAllowedResource
  • requestMetrics
"},{"location":"extensions/api/modules/Renderer.K8sApi/#references_1","title":"References","text":""},{"location":"extensions/api/modules/Renderer.K8sApi/#basekubejsonapiobjectmetadata","title":"BaseKubeJsonApiObjectMetadata","text":"

Re-exports BaseKubeJsonApiObjectMetadata

"},{"location":"extensions/api/modules/Renderer.K8sApi/#clusterrole","title":"ClusterRole","text":"

Re-exports ClusterRole

"},{"location":"extensions/api/modules/Renderer.K8sApi/#clusterrolebinding","title":"ClusterRoleBinding","text":"

Re-exports ClusterRoleBinding

"},{"location":"extensions/api/modules/Renderer.K8sApi/#clusterscopedmetadata","title":"ClusterScopedMetadata","text":"

Re-exports ClusterScopedMetadata

"},{"location":"extensions/api/modules/Renderer.K8sApi/#configmap","title":"ConfigMap","text":"

Re-exports ConfigMap

"},{"location":"extensions/api/modules/Renderer.K8sApi/#cronjob","title":"CronJob","text":"

Re-exports CronJob

"},{"location":"extensions/api/modules/Renderer.K8sApi/#customresourcedefinition","title":"CustomResourceDefinition","text":"

Re-exports CustomResourceDefinition

"},{"location":"extensions/api/modules/Renderer.K8sApi/#daemonset","title":"DaemonSet","text":"

Re-exports DaemonSet

"},{"location":"extensions/api/modules/Renderer.K8sApi/#deployment","title":"Deployment","text":"

Re-exports Deployment

"},{"location":"extensions/api/modules/Renderer.K8sApi/#deploymentapi","title":"DeploymentApi","text":"

Re-exports DeploymentApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#endpoint","title":"Endpoint","text":"

Re-exports Endpoint

"},{"location":"extensions/api/modules/Renderer.K8sApi/#externalkubeapioptions","title":"ExternalKubeApiOptions","text":"

Re-exports ExternalKubeApiOptions

"},{"location":"extensions/api/modules/Renderer.K8sApi/#horizontalpodautoscaler","title":"HorizontalPodAutoscaler","text":"

Re-exports HorizontalPodAutoscaler

"},{"location":"extensions/api/modules/Renderer.K8sApi/#horizontalpodautoscalerstore","title":"HorizontalPodAutoscalerStore","text":"

Renames and re-exports HPAStore

"},{"location":"extensions/api/modules/Renderer.K8sApi/#ikubeapicluster","title":"IKubeApiCluster","text":"

Re-exports IKubeApiCluster

"},{"location":"extensions/api/modules/Renderer.K8sApi/#ilocalkubeapiconfig","title":"ILocalKubeApiConfig","text":"

Re-exports ILocalKubeApiConfig

"},{"location":"extensions/api/modules/Renderer.K8sApi/#ipodcontainer","title":"IPodContainer","text":"

Re-exports IPodContainer

"},{"location":"extensions/api/modules/Renderer.K8sApi/#ipodcontainerstatus","title":"IPodContainerStatus","text":"

Re-exports IPodContainerStatus

"},{"location":"extensions/api/modules/Renderer.K8sApi/#iremotekubeapiconfig","title":"IRemoteKubeApiConfig","text":"

Re-exports IRemoteKubeApiConfig

"},{"location":"extensions/api/modules/Renderer.K8sApi/#isecretref","title":"ISecretRef","text":"

Re-exports ISecretRef

"},{"location":"extensions/api/modules/Renderer.K8sApi/#ignoredkubeapioptions","title":"IgnoredKubeApiOptions","text":"

Re-exports IgnoredKubeApiOptions

"},{"location":"extensions/api/modules/Renderer.K8sApi/#ingress","title":"Ingress","text":"

Re-exports Ingress

"},{"location":"extensions/api/modules/Renderer.K8sApi/#ingressapi","title":"IngressApi","text":"

Re-exports IngressApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#job","title":"Job","text":"

Re-exports Job

"},{"location":"extensions/api/modules/Renderer.K8sApi/#jsonpatch","title":"JsonPatch","text":"

Re-exports JsonPatch

"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeapi","title":"KubeApi","text":"

Re-exports KubeApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeevent","title":"KubeEvent","text":"

Re-exports KubeEvent

"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubejsonapi","title":"KubeJsonApi","text":"

Re-exports KubeJsonApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubejsonapidata","title":"KubeJsonApiData","text":"

Re-exports KubeJsonApiData

"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubejsonapidatafor","title":"KubeJsonApiDataFor","text":"

Re-exports KubeJsonApiDataFor

"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubejsonapiobjectmetadata","title":"KubeJsonApiObjectMetadata","text":"

Re-exports KubeJsonApiObjectMetadata

"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeobject","title":"KubeObject","text":"

Re-exports KubeObject

"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeobjectmetadata","title":"KubeObjectMetadata","text":"

Re-exports KubeObjectMetadata

"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeobjectstore","title":"KubeObjectStore","text":"

Re-exports KubeObjectStore

"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeobjectstoreloadallparams","title":"KubeObjectStoreLoadAllParams","text":"

Re-exports KubeObjectStoreLoadAllParams

"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeobjectstoreloadingparams","title":"KubeObjectStoreLoadingParams","text":"

Re-exports KubeObjectStoreLoadingParams

"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeobjectstoresubscribeparams","title":"KubeObjectStoreSubscribeParams","text":"

Re-exports KubeObjectStoreSubscribeParams

"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubestatus","title":"KubeStatus","text":"

Re-exports KubeStatus

"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubestatusdata","title":"KubeStatusData","text":"

Re-exports KubeStatusData

"},{"location":"extensions/api/modules/Renderer.K8sApi/#limitrange","title":"LimitRange","text":"

Re-exports LimitRange

"},{"location":"extensions/api/modules/Renderer.K8sApi/#namespace","title":"Namespace","text":"

Re-exports Namespace

"},{"location":"extensions/api/modules/Renderer.K8sApi/#namespacescopedmetadata","title":"NamespaceScopedMetadata","text":"

Re-exports NamespaceScopedMetadata

"},{"location":"extensions/api/modules/Renderer.K8sApi/#networkpolicy","title":"NetworkPolicy","text":"

Re-exports NetworkPolicy

"},{"location":"extensions/api/modules/Renderer.K8sApi/#node","title":"Node","text":"

Re-exports Node

"},{"location":"extensions/api/modules/Renderer.K8sApi/#nodesapi","title":"NodesApi","text":"

Re-exports NodesApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#ownerreference","title":"OwnerReference","text":"

Re-exports OwnerReference

"},{"location":"extensions/api/modules/Renderer.K8sApi/#persistentvolume","title":"PersistentVolume","text":"

Re-exports PersistentVolume

"},{"location":"extensions/api/modules/Renderer.K8sApi/#persistentvolumeclaim","title":"PersistentVolumeClaim","text":"

Re-exports PersistentVolumeClaim

"},{"location":"extensions/api/modules/Renderer.K8sApi/#persistentvolumeclaimsapi","title":"PersistentVolumeClaimsApi","text":"

Re-exports PersistentVolumeClaimsApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#pod","title":"Pod","text":"

Re-exports Pod

"},{"location":"extensions/api/modules/Renderer.K8sApi/#poddisruptionbudget","title":"PodDisruptionBudget","text":"

Re-exports PodDisruptionBudget

"},{"location":"extensions/api/modules/Renderer.K8sApi/#podsapi","title":"PodsApi","text":"

Re-exports PodsApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#priorityclass","title":"PriorityClass","text":"

Re-exports PriorityClass

"},{"location":"extensions/api/modules/Renderer.K8sApi/#replicaset","title":"ReplicaSet","text":"

Re-exports ReplicaSet

"},{"location":"extensions/api/modules/Renderer.K8sApi/#resourcequota","title":"ResourceQuota","text":"

Re-exports ResourceQuota

"},{"location":"extensions/api/modules/Renderer.K8sApi/#resourcestack","title":"ResourceStack","text":"

Re-exports ResourceStack

"},{"location":"extensions/api/modules/Renderer.K8sApi/#role","title":"Role","text":"

Re-exports Role

"},{"location":"extensions/api/modules/Renderer.K8sApi/#rolebinding","title":"RoleBinding","text":"

Re-exports RoleBinding

"},{"location":"extensions/api/modules/Renderer.K8sApi/#secret","title":"Secret","text":"

Re-exports Secret

"},{"location":"extensions/api/modules/Renderer.K8sApi/#service","title":"Service","text":"

Re-exports Service

"},{"location":"extensions/api/modules/Renderer.K8sApi/#serviceaccount","title":"ServiceAccount","text":"

Re-exports ServiceAccount

"},{"location":"extensions/api/modules/Renderer.K8sApi/#statefulset","title":"StatefulSet","text":"

Re-exports StatefulSet

"},{"location":"extensions/api/modules/Renderer.K8sApi/#storageclass","title":"StorageClass","text":"

Re-exports StorageClass

"},{"location":"extensions/api/modules/Renderer.K8sApi/#apimanager","title":"apiManager","text":"

Re-exports apiManager

"},{"location":"extensions/api/modules/Renderer.K8sApi/#createkubeobject","title":"createKubeObject","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Renderer.K8sApi/#createresourcestack","title":"createResourceStack","text":"

Re-exports createResourceStack

"},{"location":"extensions/api/modules/Renderer.K8sApi/#forcluster","title":"forCluster","text":"

Re-exports forCluster

"},{"location":"extensions/api/modules/Renderer.K8sApi/#forremotecluster","title":"forRemoteCluster","text":"

Re-exports forRemoteCluster

"},{"location":"extensions/api/modules/Renderer.K8sApi/#getpodsbyownerid","title":"getPodsByOwnerId","text":"

Re-exports getPodsByOwnerId

"},{"location":"extensions/api/modules/Renderer.K8sApi/#isjsonapidata","title":"isJsonApiData","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Renderer.K8sApi/#isjsonapidatalist","title":"isJsonApiDataList","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Renderer.K8sApi/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Renderer.K8sApi/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Renderer.K8sApi/#iskubeobjectnonsystem","title":"isKubeObjectNonSystem","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Renderer.K8sApi/#iskubestatusdata","title":"isKubeStatusData","text":"

Re-exports isKubeStatusData

"},{"location":"extensions/api/modules/Renderer.K8sApi/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Renderer.K8sApi/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Renderer.K8sApi/#stringifylabels","title":"stringifyLabels","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Renderer.K8sApi/#type-aliases_1","title":"Type Aliases","text":""},{"location":"extensions/api/modules/Renderer.K8sApi/#requestmetrics","title":"RequestMetrics","text":"

\u01ac RequestMetrics: ReturnType<typeof requestMetricsInjectable[\"instantiate\"]>

"},{"location":"extensions/api/modules/Renderer.K8sApi/#variables_1","title":"Variables","text":""},{"location":"extensions/api/modules/Renderer.K8sApi/#clusterroleapi","title":"clusterRoleApi","text":"

\u2022 Const clusterRoleApi: ClusterRoleApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#clusterrolebindingapi","title":"clusterRoleBindingApi","text":"

\u2022 Const clusterRoleBindingApi: ClusterRoleBindingApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#configmapapi","title":"configMapApi","text":"

\u2022 Const configMapApi: ConfigMapApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#crdapi","title":"crdApi","text":"

\u2022 Const crdApi: CustomResourceDefinitionApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#cronjobapi","title":"cronJobApi","text":"

\u2022 Const cronJobApi: CronJobApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#daemonsetapi","title":"daemonSetApi","text":"

\u2022 Const daemonSetApi: DaemonSetApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#deploymentapi_1","title":"deploymentApi","text":"

\u2022 Const deploymentApi: DeploymentApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#endpointapi","title":"endpointApi","text":"

\u2022 Const endpointApi: EndpointsApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#eventapi","title":"eventApi","text":"

\u2022 Const eventApi: KubeEventApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#hpaapi","title":"hpaApi","text":"

\u2022 Const hpaApi: HorizontalPodAutoscalerApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#ingressapi_1","title":"ingressApi","text":"

\u2022 Const ingressApi: IngressApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#jobapi","title":"jobApi","text":"

\u2022 Const jobApi: JobApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#limitrangeapi","title":"limitRangeApi","text":"

\u2022 Const limitRangeApi: LimitRangeApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#namespacesapi","title":"namespacesApi","text":"

\u2022 Const namespacesApi: NamespaceApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#networkpolicyapi","title":"networkPolicyApi","text":"

\u2022 Const networkPolicyApi: NetworkPolicyApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#nodesapi_1","title":"nodesApi","text":"

\u2022 Const nodesApi: NodeApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#pcapi","title":"pcApi","text":"

\u2022 Const pcApi: PriorityClassApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#pdbapi","title":"pdbApi","text":"

\u2022 Const pdbApi: PodDisruptionBudgetApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#persistentvolumeapi","title":"persistentVolumeApi","text":"

\u2022 Const persistentVolumeApi: PersistentVolumeApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#podsapi_1","title":"podsApi","text":"

\u2022 Const podsApi: PodApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#pvcapi","title":"pvcApi","text":"

\u2022 Const pvcApi: PersistentVolumeClaimApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#replicasetapi","title":"replicaSetApi","text":"

\u2022 Const replicaSetApi: ReplicaSetApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#resourcequotaapi","title":"resourceQuotaApi","text":"

\u2022 Const resourceQuotaApi: ResourceQuotaApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#roleapi","title":"roleApi","text":"

\u2022 Const roleApi: RoleApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#rolebindingapi","title":"roleBindingApi","text":"

\u2022 Const roleBindingApi: RoleBindingApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#secretsapi","title":"secretsApi","text":"

\u2022 Const secretsApi: SecretApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#serviceaccountsapi","title":"serviceAccountsApi","text":"

\u2022 Const serviceAccountsApi: ServiceAccountApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#serviceapi","title":"serviceApi","text":"

\u2022 Const serviceApi: ServiceApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#statefulsetapi","title":"statefulSetApi","text":"

\u2022 Const statefulSetApi: StatefulSetApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#storageclassapi","title":"storageClassApi","text":"

\u2022 Const storageClassApi: StorageClassApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#vpaapi","title":"vpaApi","text":"

\u2022 Const vpaApi: VerticalPodAutoscalerApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#functions_1","title":"Functions","text":""},{"location":"extensions/api/modules/Renderer.K8sApi/#isallowedresource","title":"isAllowedResource","text":"

\u25b8 isAllowedResource(resources): boolean

"},{"location":"extensions/api/modules/Renderer.K8sApi/#parameters","title":"Parameters","text":"Name Type resources KubeResource | KubeResource[]"},{"location":"extensions/api/modules/Renderer.K8sApi/#returns","title":"Returns","text":"

boolean

"},{"location":"extensions/api/modules/Renderer.K8sApi/#requestmetrics_1","title":"requestMetrics","text":"

\u25b8 requestMetrics(query, params?): Promise<MetricData>

"},{"location":"extensions/api/modules/Renderer.K8sApi/#parameters_1","title":"Parameters","text":"Name Type query string params? RequestMetricsParams"},{"location":"extensions/api/modules/Renderer.K8sApi/#returns_1","title":"Returns","text":"

Promise<MetricData>

\u25b8 requestMetrics(query, params?): Promise<MetricData[]>

"},{"location":"extensions/api/modules/Renderer.K8sApi/#parameters_2","title":"Parameters","text":"Name Type query string[] params? RequestMetricsParams"},{"location":"extensions/api/modules/Renderer.K8sApi/#returns_2","title":"Returns","text":"

Promise<MetricData[]>

\u25b8 requestMetrics<Keys>(query, params?): Promise<Record<Keys, MetricData>>

"},{"location":"extensions/api/modules/Renderer.K8sApi/#type-parameters","title":"Type parameters","text":"Name Type Keys extends string"},{"location":"extensions/api/modules/Renderer.K8sApi/#parameters_3","title":"Parameters","text":"Name Type query Record<Keys, Partial<Record<string, string>>> params? RequestMetricsParams"},{"location":"extensions/api/modules/Renderer.K8sApi/#returns_3","title":"Returns","text":"

Promise<Record<Keys, MetricData>>

"},{"location":"extensions/api/modules/Renderer.Navigation/","title":"Renderer.Navigation","text":"

@k8slens/extensions / Exports / Renderer / Navigation

"},{"location":"extensions/api/modules/Renderer.Navigation/#namespace-navigation","title":"Namespace: Navigation","text":"

Renderer.Navigation

"},{"location":"extensions/api/modules/Renderer.Navigation/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Renderer.Navigation/#classes","title":"Classes","text":"
  • PageParam
"},{"location":"extensions/api/modules/Renderer.Navigation/#interfaces","title":"Interfaces","text":"
  • PageParamInit
  • URLParams
"},{"location":"extensions/api/modules/Renderer.Navigation/#functions","title":"Functions","text":"
  • createPageParam
  • getDetailsUrl
  • hideDetails
  • hideEntityDetails
  • isActiveRoute
  • navigate
  • showDetails
  • showEntityDetails
"},{"location":"extensions/api/modules/Renderer.Navigation/#functions_1","title":"Functions","text":""},{"location":"extensions/api/modules/Renderer.Navigation/#createpageparam","title":"createPageParam","text":"

\u25b8 createPageParam<Value>(init): PageParam<Value>

"},{"location":"extensions/api/modules/Renderer.Navigation/#type-parameters","title":"Type parameters","text":"Name Type Value string"},{"location":"extensions/api/modules/Renderer.Navigation/#parameters","title":"Parameters","text":"Name Type init PageParamInit<Value>"},{"location":"extensions/api/modules/Renderer.Navigation/#returns","title":"Returns","text":"

PageParam<Value>

"},{"location":"extensions/api/modules/Renderer.Navigation/#getdetailsurl","title":"getDetailsUrl","text":"

\u25b8 getDetailsUrl(selfLink, resetSelected?, mergeGlobals?): string

"},{"location":"extensions/api/modules/Renderer.Navigation/#parameters_1","title":"Parameters","text":"Name Type selfLink string resetSelected? boolean mergeGlobals? boolean"},{"location":"extensions/api/modules/Renderer.Navigation/#returns_1","title":"Returns","text":"

string

"},{"location":"extensions/api/modules/Renderer.Navigation/#hidedetails","title":"hideDetails","text":"

\u25b8 hideDetails(): void

"},{"location":"extensions/api/modules/Renderer.Navigation/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/modules/Renderer.Navigation/#hideentitydetails","title":"hideEntityDetails","text":"

\u25b8 hideEntityDetails(): void

"},{"location":"extensions/api/modules/Renderer.Navigation/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/modules/Renderer.Navigation/#isactiveroute","title":"isActiveRoute","text":"

\u25b8 isActiveRoute(route): boolean

"},{"location":"extensions/api/modules/Renderer.Navigation/#parameters_2","title":"Parameters","text":"Name Type route string | RouteProps<string, {}> | string[]"},{"location":"extensions/api/modules/Renderer.Navigation/#returns_4","title":"Returns","text":"

boolean

"},{"location":"extensions/api/modules/Renderer.Navigation/#navigate","title":"navigate","text":"

\u25b8 navigate(location): void

"},{"location":"extensions/api/modules/Renderer.Navigation/#parameters_3","title":"Parameters","text":"Name Type location LocationDescriptor<unknown>"},{"location":"extensions/api/modules/Renderer.Navigation/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/modules/Renderer.Navigation/#showdetails","title":"showDetails","text":"

\u25b8 showDetails(selfLink, resetSelected?): void

Default

resetSelected true\n
"},{"location":"extensions/api/modules/Renderer.Navigation/#parameters_4","title":"Parameters","text":"Name Type Description selfLink undefined | string The Kube selflink to show details for resetSelected? boolean If true then will reset the selected kube object (which object is highlighted generally)"},{"location":"extensions/api/modules/Renderer.Navigation/#returns_6","title":"Returns","text":"

void

"},{"location":"extensions/api/modules/Renderer.Navigation/#showentitydetails","title":"showEntityDetails","text":"

\u25b8 showEntityDetails(id): void

"},{"location":"extensions/api/modules/Renderer.Navigation/#parameters_5","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/modules/Renderer.Navigation/#returns_7","title":"Returns","text":"

void

"},{"location":"extensions/api/modules/Renderer.Theme/","title":"Renderer.Theme","text":"

@k8slens/extensions / Exports / Renderer / Theme

"},{"location":"extensions/api/modules/Renderer.Theme/#namespace-theme","title":"Namespace: Theme","text":"

Renderer.Theme

"},{"location":"extensions/api/modules/Renderer.Theme/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Renderer.Theme/#interfaces","title":"Interfaces","text":"
  • LensTheme
"},{"location":"extensions/api/modules/Renderer.Theme/#variables","title":"Variables","text":"
  • activeTheme
"},{"location":"extensions/api/modules/Renderer.Theme/#functions","title":"Functions","text":"
  • getActiveTheme
"},{"location":"extensions/api/modules/Renderer.Theme/#variables_1","title":"Variables","text":""},{"location":"extensions/api/modules/Renderer.Theme/#activetheme","title":"activeTheme","text":"

\u2022 Const activeTheme: IComputedValue

"},{"location":"extensions/api/modules/Renderer.Theme/#functions_1","title":"Functions","text":""},{"location":"extensions/api/modules/Renderer.Theme/#getactivetheme","title":"getActiveTheme","text":"

\u25b8 getActiveTheme(): ReadonlyObjectDeep

Deprecated

This hides the reactivity of active theme, use activeTheme instead

"},{"location":"extensions/api/modules/Renderer.Theme/#returns","title":"Returns","text":"

ReadonlyObjectDeep

"},{"location":"extensions/api/modules/Renderer/","title":"Renderer","text":"

@k8slens/extensions / Exports / Renderer

"},{"location":"extensions/api/modules/Renderer/#namespace-renderer","title":"Namespace: Renderer","text":""},{"location":"extensions/api/modules/Renderer/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Renderer/#namespaces","title":"Namespaces","text":"
  • Catalog
  • Component
  • K8sApi
  • Navigation
  • Theme
"},{"location":"extensions/api/modules/Renderer/#classes","title":"Classes","text":"
  • Ipc
  • LensExtension
"},{"location":"extensions/capabilities/common-capabilities/","title":"Common Capabilities","text":"

Here we will discuss common and important building blocks for your extensions, and explain how you can use them. Almost all extensions use some of these functionalities.

"},{"location":"extensions/capabilities/common-capabilities/#main-extension","title":"Main Extension","text":"

The main extension runs in the background. It adds app menu items to the Lens UI. In order to see logs from this extension, you need to start Lens from the command line.

"},{"location":"extensions/capabilities/common-capabilities/#activate","title":"Activate","text":"

This extension can register a custom callback that is executed when an extension is activated (started).

import { Main } from \"@k8slens/extensions\"\n\nexport default class ExampleMainExtension extends Main.LensExtension {\nasync onActivate() {\nconsole.log(\"hello world\")\n}\n}\n
"},{"location":"extensions/capabilities/common-capabilities/#deactivate","title":"Deactivate","text":"

This extension can register a custom callback that is executed when an extension is deactivated (stopped).

import { Main } from \"@k8slens/extensions\"\n\nexport default class ExampleMainExtension extends Main.LensExtension {\nasync onDeactivate() {\nconsole.log(\"bye bye\")\n}\n}\n
"},{"location":"extensions/capabilities/common-capabilities/#menus","title":"Menus","text":"

This extension can register custom app and tray menus that will be displayed on OS native menus.

Example:

import { Main } from \"@k8slens/extensions\"\n\nexport default class ExampleMainExtension extends Main.LensExtension {\nappMenus = [\n{\nparentId: \"help\",\nlabel: \"Example item\",\nclick() {\nMain.Navigation.navigate(\"https://k8slens.dev\");\n}\n}\n]\n\ntrayMenus = [\n{\nlabel: \"My links\",\nsubmenu: [\n{\nlabel: \"Lens\",\nclick() {\nMain.Navigation.navigate(\"https://k8slens.dev\");\n}\n},\n{\ntype: \"separator\"\n},\n{\nlabel: \"Lens Github\",\nclick() {\nMain.Navigation.navigate(\"https://github.com/lensapp/lens\");\n}\n}\n]\n}\n]\n}\n
"},{"location":"extensions/capabilities/common-capabilities/#renderer-extension","title":"Renderer Extension","text":"

The renderer extension runs in a browser context, and is visible in Lens's main window. In order to see logs from this extension you need to check them via View > Toggle Developer Tools > Console.

"},{"location":"extensions/capabilities/common-capabilities/#activate_1","title":"Activate","text":"

This extension can register a custom callback that is executed when an extension is activated (started).

import { Renderer } from \"@k8slens/extensions\"\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nasync onActivate() {\nconsole.log(\"hello world\")\n}\n}\n
"},{"location":"extensions/capabilities/common-capabilities/#deactivate_1","title":"Deactivate","text":"

This extension can register a custom callback that is executed when an extension is deactivated (stopped).

import { Renderer } from \"@k8slens/extensions\"\n\nexport default class ExampleMainExtension extends Renderer.LensExtension {\nasync onDeactivate() {\nconsole.log(\"bye bye\")\n}\n}\n
"},{"location":"extensions/capabilities/common-capabilities/#global-pages","title":"Global Pages","text":"

This extension can register custom global pages (views) to Lens's main window. The global page is a full-screen page that hides all other content from a window.

import React from \"react\"\nimport { Renderer } from \"@k8slens/extensions\"\nimport { ExamplePage } from \"./src/example-page\"\n\nconst {\nComponent: {\nIcon,\n}\n} = Renderer;\n\nexport default class ExampleRendererExtension extends Renderer.LensExtension {\nglobalPages = [\n{\nid: \"example\",\ncomponents: {\nPage: ExamplePage,\n}\n}\n]\n\nglobalPageMenus = [\n{\ntitle: \"Example page\", // used in icon's tooltip\ntarget: { pageId: \"example\" }\ncomponents: {\nIcon: () => <Icon material=\"arrow\"/>,\n}\n}\n]\n}\n
"},{"location":"extensions/capabilities/common-capabilities/#app-preferences","title":"App Preferences","text":"

This extension can register custom app preferences. It is responsible for storing a state for custom preferences.

import React from \"react\"\nimport { Renderer } from \"@k8slens/extensions\"\nimport { myCustomPreferencesStore } from \"./src/my-custom-preferences-store\"\nimport { MyCustomPreferenceHint, MyCustomPreferenceInput } from \"./src/my-custom-preference\"\n\n\nexport default class ExampleRendererExtension extends Renderer.LensExtension {\nappPreferences = [\n{\ntitle: \"My Custom Preference\",\ncomponents: {\nHint: () => <MyCustomPreferenceHint/>,\nInput: () => <MyCustomPreferenceInput store={myCustomPreferencesStore}/>\n}\n}\n]\n}\n
"},{"location":"extensions/capabilities/common-capabilities/#cluster-pages","title":"Cluster Pages","text":"

This extension can register custom cluster pages. These pages are visible in a cluster menu when a cluster is opened.

import React from \"react\"\nimport { Renderer } from \"@k8slens/extensions\";\nimport { ExampleIcon, ExamplePage } from \"./src/page\"\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nclusterPages = [\n{\nid: \"extension-example\", // optional\nexact: true, // optional\ncomponents: {\nPage: () => <ExamplePage extension={this}/>,\n}\n}\n]\n\nclusterPageMenus = [\n{\nurl: \"/extension-example\", // optional\ntitle: \"Example Extension\",\ncomponents: {\nIcon: ExampleIcon,\n}\n}\n]\n}\n
"},{"location":"extensions/capabilities/common-capabilities/#top-bar-items","title":"Top Bar Items","text":"

This extension can register custom components to a top bar area.

import React from \"react\";\nimport { Renderer } from \"@k8slens/extensions\";\n\nconst {\nComponent: {\nIcon,\n}\n} = Renderer;\n\nexport default class ExampleExtension extends Renderer.LensExtension {\ntopBarItems = [\n{\ncomponents: {\nItem: () => (\n<Icon material=\"favorite\" onClick={() => this.navigate(\"/example-page\" />\n)\n}\n}\n]\n}\n
"},{"location":"extensions/capabilities/common-capabilities/#status-bar-items","title":"Status Bar Items","text":"

This extension can register custom icons and text to a status bar area.

import React from \"react\";\nimport { Renderer } from \"@k8slens/extensions\";\n\nconst {\nComponent: {\nIcon,\n}\n} = Renderer;\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nstatusBarItems = [\n{\ncomponents: {\nItem: () => (\n<div className=\"flex align-center gaps hover-highlight\" onClick={() => this.navigate(\"/example-page\")} >\n<Icon material=\"favorite\" />\n</div>\n)\n}\n}\n]\n}\n
"},{"location":"extensions/capabilities/common-capabilities/#kubernetes-workloads-overview-items","title":"Kubernetes Workloads Overview Items","text":"

This extension can register custom workloads overview items.

import React from \"react\"\nimport { Renderer } from \"@k8slens/extensions\";\nimport { CustomWorkloadsOverviewItem } from \"./src/custom-workloads-overview-item\"\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nkubeWorkloadsOverviewItems = [\n{\ncomponents: {\nDetails: () => <CustomWorkloadsOverviewItem />\n}\n}\n]\n}\n
"},{"location":"extensions/capabilities/common-capabilities/#kubernetes-object-menu-items","title":"Kubernetes Object Menu Items","text":"

This extension can register custom menu items (actions) for specified Kubernetes kinds/apiVersions.

import React from \"react\"\nimport { Renderer } from \"@k8slens/extensions\";\nimport { CustomMenuItem, CustomMenuItemProps } from \"./src/custom-menu-item\"\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nkubeObjectMenuItems = [\n{\nkind: \"Node\",\napiVersions: [\"v1\"],\ncomponents: {\nMenuItem: (props: CustomMenuItemProps) => <CustomMenuItem {...props} />\n}\n}\n]\n}\n
"},{"location":"extensions/capabilities/common-capabilities/#kubernetes-object-details","title":"Kubernetes Object Details","text":"

This extension can register custom details (content) for specified Kubernetes kinds/apiVersions.

import React from \"react\"\nimport { Renderer } from \"@k8slens/extensions\";\nimport { CustomKindDetails, CustomKindDetailsProps } from \"./src/custom-kind-details\"\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nkubeObjectDetailItems = [\n{\nkind: \"CustomKind\",\napiVersions: [\"custom.acme.org/v1\"],\ncomponents: {\nDetails: (props: CustomKindDetailsProps) => <CustomKindDetails {...props} />\n}\n}\n]\n}\n
"},{"location":"extensions/capabilities/styling/","title":"Styling an Extension","text":"

Lens provides a set of global styles and UI components that can be used by any extension to preserve the look and feel of the application.

"},{"location":"extensions/capabilities/styling/#layout","title":"Layout","text":"

For layout tasks, Lens uses the flex.box library which provides helpful class names to specify some of the flexbox properties. For example, consider the following HTML and its associated CSS properties:

<div className=\"flex column align-center\"></div>\n
div {\ndisplay: flex;\nflex-direction: column;\nalign-items: center;\n}\n

However, you are free to use any styling technique or framework you like, including Emotion or even plain CSS.

"},{"location":"extensions/capabilities/styling/#layout-variables","title":"Layout Variables","text":"

There is a set of CSS variables available for for basic layout needs. They are located inside :root and are defined in app.scss:

--unit: 8px;\n--padding: var(--unit);\n--margin: var(--unit);\n--border-radius: 3px;\n

These variables are intended to set consistent margins and paddings across components. For example:

.status {\npadding-left: calc(var(--padding) * 2);\nborder-radius: var(--border-radius);\n}\n
"},{"location":"extensions/capabilities/styling/#themes","title":"Themes","text":"

Lens uses two built-in themes defined in the themes directory \u2013 one light and one dark.

"},{"location":"extensions/capabilities/styling/#theme-variables","title":"Theme Variables","text":"

When Lens is loaded, it transforms the selected theme's json file into a list of CSS Custom Properties (CSS Variables). This list then gets injected into the :root element so that any of the down-level components can use them.

When the user changes the theme, the above process is repeated, and new CSS variables appear, replacing the previous ones.

If you want to preserve Lens's native look and feel, with respect to the lightness or darkness of your extension, you can use the provided variables and built-in Lens components such as Button, Select, Table, and so on.

There is a set of CSS variables available for extensions to use for theming. They are all located inside :root and are defined in app.scss:

--font-main: 'Roboto', 'Helvetica', 'Arial', sans-serif;\n--font-monospace: Lucida Console, Monaco, Consolas, monospace;\n--font-size-small: calc(1.5 * var(--unit));\n--font-size: calc(1.75 * var(--unit));\n--font-size-big: calc(2 * var(--unit));\n--font-weight-thin: 300;\n--font-weight-normal: 400;\n--font-weight-bold: 500;\n

as well as in the theme modules:

--blue: #3d90ce;\n--magenta: #c93dce;\n--golden: #ffc63d;\n--halfGray: #87909c80;\n--primary: #3d90ce;\n--textColorPrimary: #555555;\n--textColorSecondary: #51575d;\n--textColorAccent: #333333;\n--borderColor: #c9cfd3;\n--borderFaintColor: #dfdfdf;\n--mainBackground: #f1f1f1;\n--contentColor: #ffffff;\n--layoutBackground: #e8e8e8;\n--layoutTabsBackground: #f8f8f8;\n--layoutTabsActiveColor: #333333;\n--layoutTabsLineColor: #87909c80;\n...\n

These variables can be used in the following form: var(--magenta). For example:

.status {\nfont-size: var(--font-size-small);\nbackground-color: var(--colorSuccess);\n}\n
"},{"location":"extensions/capabilities/styling/#theme-switching","title":"Theme Switching","text":"

When the light theme is active, the <body> element gets a \"theme-light\" class, or: <body class=\"theme-light\">. If the class isn't there, the theme defaults to dark. The active theme can be changed in the Preferences page:

There is a way of detect active theme and its changes in JS. MobX observer function/decorator can be used for this purpose.

import React from \"react\"\nimport { observer } from \"mobx-react\"\nimport { Renderer } from \"@k8slens/extensions\";\n\n@observer\nexport class SupportPage extends React.Component {\nrender() {\nreturn (\n<div className=\"SupportPage\">\n<h1>Active theme is {Renderer.Theme.getActiveTheme().name}</h1>\n</div>\n);\n}\n}\n

Theme entity from @k8slens/extensions provides active theme object and @observer decorator makes component reactive - so it will rerender each time any of the observables (active theme in our case) will be changed.

Working example provided in Styling with Emotion sample extension.

"},{"location":"extensions/capabilities/styling/#injected-styles","title":"Injected Styles","text":"

Every extension is affected by the list of default global styles defined in app.scss. These are basic browser resets and element styles, including:

  • setting the box-sizing property for every element
  • default text and background colors
  • default font sizes
  • basic heading (h1, h2, etc) formatting
  • custom scrollbar styling

Extensions may overwrite these defaults if needed. They have low CSS specificity, so overriding them should be fairly easy.

"},{"location":"extensions/capabilities/styling/#css-in-js","title":"CSS-in-JS","text":"

If an extension uses a system like Emotion to work with styles, it can use CSS variables as follows:

const Container = styled.div(() => ({\nbackgroundColor: 'var(--mainBackground)'\n}));\n
"},{"location":"extensions/capabilities/styling/#examples","title":"Examples","text":"

You can explore samples for each styling technique that you can use for extensions:

  • Styling with Sass
  • Styling with Emotion
  • Styling with CSS Modules
"},{"location":"extensions/get-started/anatomy/","title":"Extension Anatomy","text":"

In the previous section you learned how to create your first extension. In this section you will learn how this extension works under the hood.

The Hello World sample extension does three things:

  • Implements onActivate() and outputs a message to the console.
  • Implements onDeactivate() and outputs a message to the console.
  • Registers ClusterPage so that the page is visible in the left-side menu of the cluster dashboard.

Let's take a closer look at our Hello World sample's source code and see how these three things are achieved.

"},{"location":"extensions/get-started/anatomy/#extension-file-structure","title":"Extension File Structure","text":"
.\n\u251c\u2500\u2500 .gitignore          // Ignore build output and node_modules\n\u251c\u2500\u2500 Makefile            // Config for build tasks that compiles the extension\n\u251c\u2500\u2500 README.md           // Readable description of your extension's functionality\n\u251c\u2500\u2500 src\n\u2502   \u2514\u2500\u2500 page.tsx         // Extension's additional source code\n\u251c\u2500\u2500 main.ts              // Source code for extension's main entrypoint\n\u251c\u2500\u2500 package.json         // Extension manifest and dependencies\n\u251c\u2500\u2500 renderer.tsx         // Source code for extension's renderer entrypoint\n\u251c\u2500\u2500 tsconfig.json        // TypeScript configuration\n\u251c\u2500\u2500 webpack.config.js    // Webpack configuration\n

The extension directory contains the extension's entry files and a few configuration files. Three files: package.json, main.ts and renderer.tsx are essential to understanding the Hello World sample extension. We'll look at those first.

"},{"location":"extensions/get-started/anatomy/#extension-manifest","title":"Extension Manifest","text":"

Each Lens extension must have a package.json file. It contains a mix of Node.js fields, including scripts and dependencies, and Lens-specific fields such as publisher and contributes. Some of the most-important fields include:

  • name and publisher: Lens uses @<publisher>/<name> as a unique ID for the extension. For example, the Hello World sample has the ID @lensapp-samples/helloworld-sample. Lens uses this ID to uniquely identify your extension.
  • main: the extension's entry point run in main process.
  • renderer: the extension's entry point run in renderer process.
  • engines.lens: the minimum version of Lens API that the extension depends upon. We only support the ^ range, which is also optional to specify, and only major and minor version numbers. Meaning that ^5.4 and 5.4 both mean the same thing, and the patch version in 5.4.2 is ignored.
{\n\"name\": \"helloworld-sample\",\n\"publisher\": \"lens-samples\",\n\"version\": \"0.0.1\",\n\"description\": \"Lens helloworld-sample\",\n\"license\": \"MIT\",\n\"homepage\": \"https://github.com/lensapp/lens-extension-samples\",\n\"engines\": {\n\"node\": \"^16.14.2\",\n\"lens\": \"5.4\"\n},\n\"main\": \"dist/main.js\",\n\"renderer\": \"dist/renderer.js\",\n\"scripts\": {\n\"build\": \"webpack --config webpack.config.js\",\n\"dev\": \"npm run build --watch\"\n},\n\"dependencies\": {\n\"react-open-doodles\": \"^1.0.5\"\n},\n\"devDependencies\": {\n\"@k8slens/extensions\": \"^5.4.6\",\n\"ts-loader\": \"^8.0.4\",\n\"typescript\": \"^4.5.5\",\n\"@types/react\": \"^17.0.44\",\n\"@types/node\": \"^16.14.2\",\n\"webpack\": \"^4.44.2\",\n\"webpack-cli\": \"^3.3.11\"\n}\n}\n
"},{"location":"extensions/get-started/anatomy/#webpack-configuration","title":"Webpack configuration","text":"

The following webpack externals are provided by Lens and must be used (when available) to make sure that the versions used are in sync.

Package webpack external syntax Lens versions Available in Main Available in Renderer mobx var global.Mobx >5.0.0 \u2705 \u2705 mobx-react var global.MobxReact >5.0.0 \u274c \u2705 react var global.React >5.0.0 \u274c \u2705 react-router var global.ReactRouter >5.0.0 \u274c \u2705 react-router-dom var global.ReactRouterDom >5.0.0 \u274c \u2705 react-dom var global.ReactDOM >5.5.0 \u274c \u2705

What is exported is the whole of the packages as a * import (within typescript).

For example, the following is how you would specify these within your webpack configuration files.

{\n...\n\"externals\": [\n...\n{\n\"mobx\": \"var global.Mobx\"\n\"mobx-react\": \"var global.MobxReact\"\n\"react\": \"var global.React\"\n\"react-router\": \"var global.ReactRouter\"\n\"react-router-dom\": \"var global.ReactRouterDom\"\n\"react-dom\": \"var global.ReactDOM\"\n}\n]\n}\n
"},{"location":"extensions/get-started/anatomy/#extension-entry-files","title":"Extension Entry Files","text":"

Lens extensions can have two separate entry files. One file is used in the main process of the Lens application and the other is used in the renderer process. The main entry file exports the class that extends LensMainExtension, and the renderer entry file exports the class that extends LensRendererExtension.

Both extension classes have onActivate and onDeactivate methods. The onActivate method is executed when your extension is activated. If you need to initialize something in your extension, this is where such an operation should occur. The onDeactivate method gives you a chance to clean up before your extension becomes deactivated. For extensions where explicit cleanup is not required, you don't need to override this method. However, if an extension needs to perform an operation when Lens is shutting down (or if the extension is disabled or uninstalled), this is the method where such an operation should occur.

The Hello World sample extension does not do anything on the main process, so we'll focus on the renderer process, instead. On the renderer entry point, the Hello World sample extension defines the Cluster Page object. The Cluster Page object registers the /extension-example path, and this path renders the ExamplePage React component. It also registers the MenuItem component that displays the ExampleIcon React component and the \"Hello World\" text in the left-side menu of the cluster dashboard. These React components are defined in the additional ./src/page.tsx file.

import { Renderer } from \"@k8slens/extensions\";\nimport { ExampleIcon, ExamplePage } from \"./page\";\nimport React from \"react\";\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nclusterPages = [\n{\nid: \"extension-example\",\ncomponents: {\nPage: () => <ExamplePage extension={this} />,\n},\n},\n];\n}\n

The Hello World sample extension uses the Cluster Page capability, which is just one of the Lens extension API's capabilities. The Common Capabilities page will help you home in on the right capabilities to use with your own extensions.

"},{"location":"extensions/get-started/overview/","title":"Extension Development Overview","text":"

This is a general overview to how the development of an extension will proceed. For building extensions there will be a few things that you should have installed, and some other things that might be of help.

"},{"location":"extensions/get-started/overview/#required","title":"Required:","text":"
  • Node.js
  • Git
  • Some sort of text editor \u2013 we recommend VSCode
  • We use Webpack for compilation. All extension need to be at least compatible with a webpack system.
"},{"location":"extensions/get-started/overview/#recommended","title":"Recommended:","text":"

All Lens extensions are javascript packages. We recommend that you program in Typescript because it catches many common errors.

Lens is a standard Electron application with both main and renderer processes. An extension is made up of two parts, one for each of Lens's core processes. When an extension is loaded, each part is first loaded and issues a notification that it has been loaded. From there, the extension can start doing is work.

Lens uses React as its UI framework and provides some of Lens's own components for reuse with extensions. An extension is responsible for the lifetime of any resources it spins up. If an extension's main part starts new processes they all must be stopped and cleaned up when the extension is deactivated or unloaded.

See Your First Extension to get started.

"},{"location":"extensions/get-started/wrapping-up/","title":"Wrapping Up","text":"

In Your First Extension, you learned how to create and run an extension. In Extension Anatomy, you learned in detail how a basic extension works. This is just a glimpse into what can be created with Lens extensions. Below are some suggested routes for learning more.

"},{"location":"extensions/get-started/wrapping-up/#extension-capabilities","title":"Extension Capabilities","text":"

In this section, you'll find information on common extension capabilities, styling information, and a color reference guide. Determine whether your idea for an extension is doable and get ideas for new extensions by reading through the Common Capabilities page.

"},{"location":"extensions/get-started/wrapping-up/#guides-and-samples","title":"Guides and Samples","text":"

Here you'll find a collection of sample extensions that you can use as a base to work from. Some of these samples include a detailed guide that explains the source code. You can find all samples and guides in the lens-extension-samples repository.

"},{"location":"extensions/get-started/wrapping-up/#testing-and-publishing","title":"Testing and Publishing","text":"

In this section, you can learn:

  • How to add integration tests to your extension
  • How to publish your extension
"},{"location":"extensions/get-started/your-first-extension/","title":"Your First Extension","text":"

We recommend to always use Yeoman generator for Lens Extension to start new extension project. Read the generator guide here.

If you want to setup the project manually, please continue reading.

"},{"location":"extensions/get-started/your-first-extension/#first-extension","title":"First Extension","text":"

In this topic, you'll learn the basics of building extensions by creating an extension that adds a \"Hello World\" page to a cluster menu.

"},{"location":"extensions/get-started/your-first-extension/#install-the-extension","title":"Install the Extension","text":"

To install the extension, clone the Lens Extension samples repository to your local machine:

git clone https://github.com/lensapp/lens-extension-samples.git\n

Next you need to create a symlink. A symlink connects the directory that Lens will monitor for user-installed extensions to the sample extension. In this case the sample extension is helloworld-sample.

"},{"location":"extensions/get-started/your-first-extension/#linux-macos","title":"Linux & macOS","text":"
mkdir -p ~/.k8slens/extensions\ncd ~/.k8slens/extensions\nln -s lens-extension-samples/helloworld-sample helloworld-sample\n
"},{"location":"extensions/get-started/your-first-extension/#windows","title":"Windows","text":"

Create the directory that Lens will monitor for user-installed extensions:

mkdir C:\\Users\\<user>\\.k8slens\\extensions -force\ncd C:\\Users\\<user>\\.k8slens\\extensions\n

If you have administrator rights, you can create symlink to the sample extension \u2013 in this case helloworld-sample:

cmd /c mklink /D helloworld-sample lens-extension-samples\\helloworld-sample\n

Without administrator rights, you need to copy the extensions sample directory into C:\\Users\\<user>\\.k8slens\\extensions:

Copy-Item 'lens-extension-samples\\helloworld-sample' 'C:\\Users\\<user>\\.k8slens\\extensions\\helloworld-sample'\n
"},{"location":"extensions/get-started/your-first-extension/#build-the-extension","title":"Build the Extension","text":"

To build the extension you can use make or run the npm commands manually:

cd <lens-extension-samples directory>/helloworld-sample\nmake build\n

To run the npm commands, enter:

cd <lens-extension-samples directory>/helloworld-sample\nnpm install\nnpm run build\n

Optionally, automatically rebuild the extension by watching for changes to the source code. To do so, enter:

cd <lens-extension-samples directory>/helloworld-sample\nnpm run dev\n

You must restart Lens for the extension to load. After this initial restart, reload Lens and it will automatically pick up changes any time the extension rebuilds.

With Lens running, either connect to an existing cluster or create a new one - refer to the latest Lens Documentation for details on how to add a cluster in Lens IDE. You will see the \"Hello World\" page in the left-side cluster menu.

"},{"location":"extensions/get-started/your-first-extension/#develop-the-extension","title":"Develop the Extension","text":"

Finally, you'll make a change to the message that our Hello World sample extension displays:

  1. Navigate to <lens-extension-samples directory>/helloworld-sample.
  2. In page.tsx, change the message from HelloWorld! to Hello Lens Extensions.
  3. Rebuild the extension. If you used npm run dev, the extension will rebuild automatically.
  4. Reload the Lens window.
  5. Click on the Hello World page.
  6. The updated message will appear.
"},{"location":"extensions/get-started/your-first-extension/#next-steps","title":"Next Steps","text":"

In the next topic, we'll take a closer look at the source code of our Hello World sample.

You can find the source code for this tutorial at: lensapp/lens-extension-samples. Extension Guides contains additional samples.

"},{"location":"extensions/guides/","title":"Extension Guides","text":"

This section explains how to use specific Lens Extension APIs. It includes detailed guides and code samples. For introductory information about the Lens Extension API, please see Your First Extension.

Each guide or code sample includes the following:

  • Clearly commented source code.
  • Instructions for running the sample extension.
  • An image showing the sample extension's appearance and usage.
  • A listing of the Extension API being used.
  • An explanation of the concepts relevant to the Extension.
"},{"location":"extensions/guides/#guides","title":"Guides","text":"Guide APIs Generate new extension project Main process extension Main.LensExtension Renderer process extension Renderer.LensExtension Resource stack (cluster feature) Extending KubernetesCluster) Stores Components KubeObjectListLayout Working with mobx Protocol Handlers Sending Data between main and renderer Catalog Entities and Categories"},{"location":"extensions/guides/#samples","title":"Samples","text":"Sample APIs hello-world LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps styling-css-modules-sample LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps styling-emotion-sample LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps styling-sass-sample LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps custom-resource-page LensRendererExtension Renderer.K8sApi.KubeApi Renderer.K8sApi.KubeObjectStore Renderer.Component.KubeObjectListLayout Renderer.Component.KubeObjectDetailsProps Renderer.Component.IconProps"},{"location":"extensions/guides/anatomy/","title":"Anatomy","text":""},{"location":"extensions/guides/anatomy/#wip","title":"WIP","text":""},{"location":"extensions/guides/catalog/","title":"Catalog (WIP)","text":"

This guide is a brief overview about how the catalog works within Lens. The catalog should be thought of as the single source of truth about data within Lens.

The data flow is unidirectional, it only flows from the main side to the renderer side. All data is public within the catalog.

"},{"location":"extensions/guides/catalog/#categories","title":"Categories","text":"

A category is the declaration to the catalog of a specific kind of entity. It declares the currently supported versions of that kind of entity but providing the constructors for the entity classes.

To declare a new category class you must create a new class that extends Common.Catalog.CatalogCategory and implement all of the abstract fields.

The categories provided by Lens itself have the following names:

  • KubernetesClusters
  • WebLinks
  • General

To register a category, call the Main.Catalog.catalogCategories.add() and Renderer.Catalog.catalogCategories.add() with instances of your class.

"},{"location":"extensions/guides/catalog/#custom-category-views","title":"Custom Category Views","text":"

By default when a specific category is selected in the catalog page a list of entities of the group and kind that the category has registered. It is possible to register custom views for specific categories by registering them on your Renderer.LensExtension class.

A registration takes the form of a Common.Types.CustomCategoryViewRegistration

For example:

import { Renderer, Common } from \"@k8slens/extensions\";\n\nfunction MyKubernetesClusterView({\ncategory,\n}: Common.Types.CustomCategoryViewProps) {\nreturn <div>My view: {category.getId()}</div>;\n}\n\nexport default class extends Renderer.LensExtension {\ncustomCategoryViews = [\n{\ngroup: \"entity.k8slens.dev\",\nkind: \"KubernetesCluster\",\npriority: 10,\ncomponents: {\nView: MyKubernetesClusterView,\n},\n},\n];\n}\n

Will register a new view for the KubernetesCluster category, and because the priority is < 50 it will be displayed above the default list view.

The default list view has a priority of 50 and and custom views with priority (defaulting to 50) >= 50 will be displayed afterwards.

"},{"location":"extensions/guides/catalog/#styling-custom-views","title":"Styling Custom Views","text":"

By default, custom view blocks are styled with Flexbox. Some details comes from this.

  • To set fixed height of a custom block, use max-height css rule.
  • To set flexible height, use height.
  • Otherwise, custom view will have height of it's contents.
"},{"location":"extensions/guides/catalog/#entities","title":"Entities","text":"

An entity is the data within the catalog. All entities are typed and the class instances will be recreated on the renderer side by the catalog and the category registrations.

"},{"location":"extensions/guides/components/","title":"Components","text":""},{"location":"extensions/guides/components/#wip","title":"WIP","text":""},{"location":"extensions/guides/extending-kubernetes-cluster/","title":"Extending KubernetesCluster","text":"

Extension can specify it's own subclass of Common.Catalog.KubernetesCluster. Extension can also specify a new Category for it in the Catalog.

"},{"location":"extensions/guides/extending-kubernetes-cluster/#extending-commoncatalogkubernetescluster","title":"Extending Common.Catalog.KubernetesCluster","text":"
import { Common } from \"@k8slens/extensions\";\n\n// The kind must be different from KubernetesCluster's kind\nexport const kind = \"ManagedDevCluster\";\n\nexport class ManagedDevCluster extends Common.Catalog.KubernetesCluster {\npublic static readonly kind = kind;\n\npublic readonly kind = kind;\n}\n
"},{"location":"extensions/guides/extending-kubernetes-cluster/#extending-commoncatalogcatalogcategory","title":"Extending Common.Catalog.CatalogCategory","text":"

These custom Catalog entities can be added a new Category in the Catalog.

import { Common } from \"@k8slens/extensions\";\nimport { kind, ManagedDevCluster } from \"../entities/ManagedDevCluster\";\n\nclass ManagedDevClusterCategory extends Common.Catalog.CatalogCategory {\npublic readonly apiVersion = \"catalog.k8slens.dev/v1alpha1\";\npublic readonly kind = \"CatalogCategory\";\npublic metadata = {\nname: \"Managed Dev Clusters\",\nicon: \"\"\n};\npublic spec: Common.Catalog.CatalogCategorySpec = {\ngroup: \"entity.k8slens.dev\",\nversions: [\n{\nname: \"v1alpha1\",\nentityClass: ManagedDevCluster as any,\n},\n],\nnames: {\nkind\n},\n};\n}\n\nexport { ManagedDevClusterCategory };\nexport type { ManagedDevClusterCategory as ManagedDevClusterCategoryType };\n

The category needs to be registered in the onActivate() method both in main and renderer

// in main's on onActivate\nMain.Catalog.catalogCategories.add(new ManagedDevClusterCategory());\n
// in renderer's on onActivate\nRenderer.Catalog.catalogCategories.add(new ManagedDevClusterCategory());\n

You can then add the entities to the Catalog as a new source:

this.addCatalogSource(\"managedDevClusters\", this.managedDevClusters);\n
"},{"location":"extensions/guides/generator/","title":"Lens Extension Generator","text":"

The Lens Extension Generator creates a directory with the necessary files for developing an extension.

"},{"location":"extensions/guides/generator/#installing-and-getting-started-with-the-generator","title":"Installing and Getting Started with the Generator","text":"

To begin, install Yeoman and the Lens Extension Generator with the following command:

npm install -g yo generator-lens-ext\n

Run the generator by entering the following command: yo lens-ext.

Answer the following questions:

# ? What type of extension do you want to create? New Extension (TypeScript)\n# ? What's the name of your extension? my-first-lens-ext\n# ? What's the description of your extension? My hello world extension\n# ? What's your extension's publisher name? @my-org/my-first-lens-ext\n# ? Initialize a git repository? Yes\n# ? Install dependencies after initialization? Yes\n# ? Which package manager to use? yarn\n# ? symlink created extension folder to ~/.k8slens/extensions (mac/linux) or :Users\\<user>\\.k8slens\\extensions (windows)? Yes\n

Next, you'll need to have webpack watch the my-first-lens-ext folder. Start webpack by entering:

cd my-first-lens-ext\nnpm start # start the webpack server in watch mode\n

Open Lens and you will see a Hello World item in the left-side menu under Custom Resources:

"},{"location":"extensions/guides/generator/#developing-the-extension","title":"Developing the Extension","text":"

Next, you'll try changing the way the new menu item appears in the UI. You'll change it from \"Hello World\" to \"Hello Lens\".

Open my-first-lens-ext/renderer.tsx and change the value of title from \"Hello World\" to \"Hello Lens\":

clusterPageMenus = [\n{\ntarget: { pageId: \"hello\" },\ntitle: \"Hello Lens\",\ncomponents: {\nIcon: ExampleIcon,\n},\n},\n];\n

Reload Lens and you will see that the menu item text has changed to \"Hello Lens\". To reload Lens, enter CMD+R on Mac and Ctrl+R on Windows/Linux.

"},{"location":"extensions/guides/generator/#debugging-the-extension","title":"Debugging the Extension","text":"

To debug your extension, please see our instructions on Testing Extensions.

"},{"location":"extensions/guides/generator/#next-steps","title":"Next Steps","text":"

To dive deeper, consider looking at Common Capabilities, Styling, or Extension Anatomy.

If you find problems with the Lens Extension Generator, or have feature requests, you are welcome to raise an issue. You can find the latest Lens contribution guidelines here.

The Generator source code is hosted at GitHub.

"},{"location":"extensions/guides/ipc/","title":"Inter Process Communication","text":"

A Lens Extension can utilize IPC to send information between the renderer and main processes. This is useful when wanting to communicate directly within your extension.

For example, if a user logs into a service that your extension is a facade for and main needs to know some information so that you can start syncing items to the Catalog, this would be a good way to send that information along.

IPC channels are sectioned off per extension. Meaning that each extension can only communicate with itself.

"},{"location":"extensions/guides/ipc/#types-of-communication","title":"Types of Communication","text":"

There are two flavours of communication that are provided:

  • Event based (IPC)
  • Request based (RPC)
"},{"location":"extensions/guides/ipc/#event-based-or-ipc","title":"Event Based or IPC","text":"

This is the same as an Event Emitter but is not limited to just one Javascript process. This is a good option when you need to report that something has happened but you don't need a response.

This is a fully two-way form of communication. Both main and renderer can do this sort of IPC.

"},{"location":"extensions/guides/ipc/#request-based-or-rpc","title":"Request Based or RPC","text":"

This is more like a Remote Procedure Call (RPC) or Send-Receive-Reply (SRR). With this sort of communication the caller needs to wait for the result from the other side. This is accomplished by await-ing the returned Promise<any>.

This is a unidirectional form of communication. Only renderer can initiate this kind of request, and only main can receive and respond to this kind of request.

"},{"location":"extensions/guides/ipc/#registering-ipc-handlers-and-listeners","title":"Registering IPC Handlers and Listeners","text":"

The general terminology is as follows:

  • A \"handler\" is the function that responds to a \"Request Based IPC\" event.
  • A \"listener\" is the function that is called when a \"Event Based IPC\" event is emitted.

To register either a handler or a listener, you should do something like the following:

main.ts:

import { Main } from \"@k8slens/extensions\";\nimport { IpcMain } from \"./helpers/main\";\n\nexport class ExampleExtensionMain extends Main.LensExtension {\nonActivate() {\nIpcMain.createInstance(this);\n}\n}\n

This file shows that you need to create an instance of the store to be able to use IPC. Lens will automatically clean up that store and all the handlers on deactivation and uninstall.

helpers/main.ts:

import { Main } from \"@k8slens/extensions\";\n\nexport class IpcMain extends Main.Ipc {\nconstructor(extension: Main.LensExtension) {\nsuper(extension);\n\nthis.listen(\"initialize\", onInitialize);\n}\n}\n\nfunction onInitialize(event: Types.IpcMainEvent, id: string) {\nconsole.log(`starting to initialize: ${id}`);\n}\n

In other files, it is not necessary to pass around any instances. You should be able to just call IpcMain.getInstance() anywhere it is needed in your extension.

renderer.ts:

import { Renderer } from \"@k8slens/extensions\";\nimport { IpcRenderer } from \"./helpers/renderer\";\n\nexport class ExampleExtensionRenderer extends Renderer.LensExtension {\nonActivate() {\nconst ipc = IpcRenderer.createInstance(this);\n\nsetTimeout(() => ipc.broadcast(\"initialize\", \"an-id\"), 5000);\n}\n}\n

It is also needed to create an instance to broadcast messages too.

helpers/renderer.ts:

import { Renderer } from \"@k8slens/extensions\";\n\nexport class IpcRenderer extends Renderer.Ipc {}\n

It is necessary to create child classes of these abstract class's in your extension before you can use them.

As this example shows: the channel names must be the same. It should also be noted that \"listeners\" and \"handlers\" are specific to either renderer or main. There is no behind the scenes transfer of these functions.

To register a \"handler\" call IpcMain.getInstance().handle(...). The cleanup of these handlers is handled by Lens itself.

The listen() methods on Main.Ipc and Renderer.Ipc return a Disposer, or more specifically, a () => void. This can be optionally called to remove the listener early.

Calling either IpcRenderer.getInstance().broadcast(...) or IpcMain.getInstance().broadcast(...) sends an event to all renderer frames and to main. Because of this, no matter where you broadcast from, all listeners in main and renderer will be notified.

"},{"location":"extensions/guides/ipc/#allowed-values","title":"Allowed Values","text":"

This IPC mechanism utilizes the Structured Clone Algorithm for serialization. This means that more types than what are JSON serializable can be used, but not all the information will be passed through.

"},{"location":"extensions/guides/ipc/#using-request-based-communication","title":"Using Request Based Communication","text":"

If you are meaning to do a request based call from renderer, you should do const res = await IpcRenderer.getInstance().invoke(<channel>, ...<args>)); instead.

"},{"location":"extensions/guides/kube-object-list-layout/","title":"KubeObjectListLayout Sample","text":"

In this guide we will learn how to list Kubernetes CRD objects on the cluster dashboard. You can see the complete source code for this guide here.

Next, we will go the implementation through in steps. To achieve our goal, we need to:

  1. Register ClusterPage and ClusterPageMenu objects
  2. List Certificate Objects on the Cluster Page
  3. Customize Details Panel
"},{"location":"extensions/guides/kube-object-list-layout/#register-clusterpage-and-clusterpagemenu-objects","title":"Register clusterPage and clusterPageMenu Objects","text":"

First thing we need to do with our extension is to register new menu item in the cluster menu and create a cluster page that is opened when clicking the menu item. We will do this in our extension class CrdSampleExtension that is derived LensRendererExtension class:

export default class CrdSampleExtension extends Renderer.LensExtension {\n}\n

To register menu item in the cluster menu we need to register PageMenuRegistration object. This object will register a menu item with \"Certificates\" text. It will also use CertificateIcon component to render an icon and navigate to cluster page that is having certificates page id.

import { Renderer } from \"@k8slens/extensions\";\n\ntype IconProps = Renderer.Component.IconProps;\n\nconst {\nComponent: {\nIcon,\n},\n} = Renderer;\n\nexport function CertificateIcon(props: IconProps) {\nreturn <Icon {...props} material=\"security\" tooltip=\"Certificates\"/>\n}\n\nexport default class CrdSampleExtension extends Renderer.LensExtension {\n\nclusterPageMenus = [\n{\ntarget: { pageId: \"certificates\" },\ntitle: \"Certificates\",\ncomponents: {\nIcon: CertificateIcon,\n}\n},\n]\n}\n

Then we need to register PageRegistration object with certificates id and define CertificatePage component to render certificates.

export default class CrdSampleExtension extends Renderer.LensExtension {\n...\n\nclusterPages = [{\nid: \"certificates\",\ncomponents: {\nPage: () => <CertificatePage extension={this} />,\nMenuIcon: CertificateIcon,\n}\n}]\n}\n
"},{"location":"extensions/guides/kube-object-list-layout/#list-certificate-objects-on-the-cluster-page","title":"List Certificate Objects on the Cluster Page","text":"

In the previous step we defined CertificatePage component to render certificates. In this step we will actually implement that. CertificatePage is a React component that will render Renderer.Component.KubeObjectListLayout component to list Certificate CRD objects.

"},{"location":"extensions/guides/kube-object-list-layout/#get-crd-objects","title":"Get CRD objects","text":"

In order to list CRD objects, we need first fetch those from Kubernetes API. Lens Extensions API provides easy mechanism to do this. We just need to define Certificate class derived from Renderer.K8sApi.KubeObject, CertificatesApiderived from Renderer.K8sApi.KubeApi and CertificatesStore derived from Renderer.K8sApi.KubeObjectStore.

Certificate class defines properties found in the CRD object:

import { Renderer } from \"@k8slens/extensions\";\n\nconst {\nK8sApi: {\nKubeObject,\nKubeObjectStore,\nKubeApi,\napiManager,\n},\n} = Renderer;\n\nexport class Certificate extends KubeObject {\nstatic kind = \"Certificate\"\nstatic namespaced = true\nstatic apiBase = \"/apis/cert-manager.io/v1alpha2/certificates\"\n\nkind: string\napiVersion: string\nmetadata: {\nname: string;\nnamespace: string;\nselfLink: string;\nuid: string;\nresourceVersion: string;\ncreationTimestamp: string;\nlabels: {\n[key: string]: string;\n};\nannotations: {\n[key: string]: string;\n};\n}\nspec: {\ndnsNames: string[];\nissuerRef: {\ngroup: string;\nkind: string;\nname: string;\n}\nsecretName: string\n}\nstatus: {\nconditions: {\nlastTransitionTime: string;\nmessage: string;\nreason: string;\nstatus: string;\ntype?: string;\n}[];\n}\n}\n

With CertificatesApi class we are able to manage Certificate objects in Kubernetes API:

export class CertificatesApi extends KubeApi<Certificate> {}\n\nexport const certificatesApi = new CertificatesApi({\nobjectConstructor: Certificate\n});\n

CertificateStore defines storage for Certificate objects

export class CertificatesStore extends KubeObjectStore<Certificate> {\napi = certificatesApi\n}\n\nexport const certificatesStore = new CertificatesStore();\n

And, finally, we register this store to Lens's API manager.

apiManager.registerStore(certificatesStore);\n
"},{"location":"extensions/guides/kube-object-list-layout/#create-certificatepage-component","title":"Create CertificatePage component","text":"

Now we have created mechanism to manage Certificate objects in Kubernetes API. Then we need to fetch those and render them in the UI.

First we define CertificatePage class that extends React.Component.

import { Renderer } from \"@k8slens/extensions\";\nimport React from \"react\";\nimport { certificatesStore } from \"../certificate-store\";\nimport { Certificate } from \"../certificate\"\n\nexport class CertificatePage extends React.Component<{ extension: Renderer.LensExtension }> {\n\n}\n

Next we will implement render method that will display certificates in a list. To do that, we just need to add Renderer.Component.KubeObjectListLayout component inside Renderer.Component.TabLayout component in render method. To define which objects the list is showing, we need to pass certificateStore object to Renderer.Component.KubeObjectListLayout in store property. Renderer.Component.KubeObjectListLayout will fetch automatically items from the given store when component is mounted. Also, we can define needed sorting callbacks and search filters for the list:

import { Renderer } from \"@k8slens/extensions\";\n\nconst {\nComponent: {\nTabLayout,\nKubeObjectListLayout,\n},\n} = Renderer;\n\nenum sortBy {\nname = \"name\",\nnamespace = \"namespace\",\nissuer = \"issuer\"\n}\n\nexport class CertificatePage extends React.Component<{ extension: LensRendererExtension }> {\n// ...\n\nrender() {\nreturn (\n<TabLayout>\n<KubeObjectListLayout\nclassName=\"Certificates\" store={certificatesStore}\nsortingCallbacks={{\n[sortBy.name]: (certificate: Certificate) => certificate.getName(),\n[sortBy.namespace]: (certificate: Certificate) => certificate.metadata.namespace,\n[sortBy.issuer]: (certificate: Certificate) => certificate.spec.issuerRef.name\n}}\nsearchFilters={[\n(certificate: Certificate) => certificate.getSearchFields()\n]}\nrenderHeaderTitle=\"Certificates\"\nrenderTableHeader={[\n{ title: \"Name\", className: \"name\", sortBy: sortBy.name },\n{ title: \"Namespace\", className: \"namespace\", sortBy: sortBy.namespace },\n{ title: \"Issuer\", className: \"issuer\", sortBy: sortBy.namespace },\n]}\nrenderTableContents={(certificate: Certificate) => [\ncertificate.getName(),\ncertificate.metadata.namespace,\ncertificate.spec.issuerRef.name\n]}\n/>\n</TabLayout>\n)\n}\n}\n
"},{"location":"extensions/guides/kube-object-list-layout/#customize-details-panel","title":"Customize Details panel","text":"

We have learned now, how to list CRD objects in a list view. Next, we will learn how to customize details panel that will be opened when the object is clicked in the list.

First, we need to register our custom component to render details for the specific Kubernetes custom resource, in our case Certificate. We will do this again in CrdSampleExtension class:

export default class CrdSampleExtension extends Renderer.LensExtension {\n//...\n\nkubeObjectDetailItems = [{\nkind: Certificate.kind,\napiVersions: [\"cert-manager.io/v1alpha2\"],\ncomponents: {\nDetails: (props: CertificateDetailsProps) => <CertificateDetails {...props} />\n}\n}]\n}\n

Here we defined that CertificateDetails component will render the resource details. So, next we need to implement that component. Lens will inject Certificate object into our component so we just need to render some information out of it. We can use Renderer.Component.DrawerItem component from Lens Extensions API to give the same look and feel as Lens is using elsewhere:

import { Renderer } from \"@k8slens/extensions\";\nimport React from \"react\";\nimport { Certificate } from \"../certificate\";\n\nconst {\nComponent: {\nKubeObjectDetailsProps,\nDrawerItem,\nBadge,\n}\n} = Renderer;\n\nexport interface CertificateDetailsProps extends KubeObjectDetailsProps<Certificate>{\n}\n\nexport class CertificateDetails extends React.Component<CertificateDetailsProps> {\n\nrender() {\nconst { object: certificate } = this.props;\nif (!certificate) return null;\nreturn (\n<div className=\"Certificate\">\n<DrawerItem name=\"Created\">\n{certificate.getAge(true, false)} ago ({certificate.metadata.creationTimestamp })\n</DrawerItem>\n<DrawerItem name=\"DNS Names\">\n{certificate.spec.dnsNames.join(\",\")}\n</DrawerItem>\n<DrawerItem name=\"Secret\">\n{certificate.spec.secretName}\n</DrawerItem>\n<DrawerItem name=\"Status\" className=\"status\" labelsOnly>\n{certificate.status.conditions.map((condition, index) => {\nconst { type, reason, message, status } = condition;\nconst kind = type || reason;\nif (!kind) return null;\nreturn (\n<Badge\nkey={kind + index} label={kind}\nclassName={\"success \"+kind.toLowerCase()}\ntooltip={message}\n/>\n);\n})}\n</DrawerItem>\n</div>\n)\n}\n}\n
"},{"location":"extensions/guides/kube-object-list-layout/#summary","title":"Summary","text":"

Like we can see above, it's very easy to add custom pages and fetch Kubernetes resources by using Extensions API. Please see the complete source code to test it out.

"},{"location":"extensions/guides/main-extension/","title":"Main Extension","text":"

The Main Extension API is the interface to Lens's main process. Lens runs in both main and renderer processes. The Main Extension API allows you to access, configure, and customize Lens data, add custom application menu items and protocol handlers, and run custom code in Lens's main process. It also provides convenient methods for navigating to built-in Lens pages and extension pages, as well as adding and removing sources of catalog entities.

"},{"location":"extensions/guides/main-extension/#mainlensextension-class","title":"Main.LensExtension Class","text":""},{"location":"extensions/guides/main-extension/#onactivate-and-ondeactivate-methods","title":"onActivate() and onDeactivate() Methods","text":"

To create a main extension simply extend the Main.LensExtension class:

import { Main } from \"@k8slens/extensions\";\n\nexport default class ExampleExtensionMain extends Main.LensExtension {\nonActivate() {\nconsole.log(\"custom main process extension code started\");\n}\n\nonDeactivate() {\nconsole.log(\"custom main process extension de-activated\");\n}\n}\n

Two methods enable you to run custom code: onActivate() and onDeactivate(). Enabling your extension calls onActivate() and disabling your extension calls onDeactivate(). You can initiate custom code by implementing onActivate(). Implementing onDeactivate() gives you the opportunity to clean up after your extension.

Disable extensions from the Lens Extensions page:

  1. Navigate to File > Extensions in the top menu bar. (On Mac, it is Lens > Extensions.)
  2. Click Disable on the extension you want to disable.

The example above logs messages when the extension is enabled and disabled. To see standard output from the main process there must be a console connected to it. Achieve this by starting Lens from the command prompt.

For more details on accessing Lens state data, please see the Stores guide.

"},{"location":"extensions/guides/main-extension/#appmenus","title":"appMenus","text":"

The Main Extension API allows you to customize the UI application menu. The following example demonstrates adding an item to the Help menu.

import { Main } from \"@k8slens/extensions\";\n\nexport default class SamplePageMainExtension extends Main.LensExtension {\nappMenus = [\n{\nparentId: \"help\",\nlabel: \"Sample\",\nclick() {\nconsole.log(\"Sample clicked\");\n},\n},\n];\n}\n

appMenus is an array of objects that satisfy the MenuRegistration interface. MenuRegistration extends Electron's MenuItemConstructorOptions interface. The properties of the appMenus array objects are defined as follows:

  • parentId is the name of the menu where your new menu item will be listed. Valid values include: \"file\", \"edit\", \"view\", and \"help\". \"lens\" is valid on Mac only.
  • label is the name of your menu item.
  • click() is called when the menu item is selected. In this example, we simply log a message. However, you would typically have this navigate to a specific page or perform another operation. Note that pages are associated with the Renderer.LensExtension class and can be defined in the process of extending it.

The following example demonstrates how an application menu can be used to navigate to such a page:

import { Main } from \"@k8slens/extensions\";\n\nexport default class SamplePageMainExtension extends Main.LensExtension {\nappMenus = [\n{\nparentId: \"help\",\nlabel: \"Sample\",\nclick: () => this.navigate(\"myGlobalPage\"),\n},\n];\n}\n

When the menu item is clicked the navigate() method looks for and displays a global page with id \"myGlobalPage\". This page would be defined in your extension's Renderer.LensExtension implementation (See Renderer.LensExtension).

"},{"location":"extensions/guides/main-extension/#traymenus","title":"trayMenus","text":"

trayMenus is an array of TrayMenuRegistration objects. Most importantly you can define a label and a click handler. Other properties are submenu, enabled, toolTip, id and type.

interface TrayMenuRegistration {\nlabel?: string;\nclick?: (menuItem: TrayMenuRegistration) => void;\nid?: string;\ntype?: \"normal\" | \"separator\" | \"submenu\";\ntoolTip?: string;\nenabled?: boolean;\nsubmenu?: TrayMenuRegistration[];\n}\n

The following example demonstrates how tray menus can be added from extension:

import { Main } from \"@k8slens/extensions\";\n\nexport default class SampleTrayMenuMainExtension extends Main.LensExtension {\ntrayMenus = [\n{\nlabel: \"menu from the extension\",\nclick: () => {\nconsole.log(\"tray menu clicked!\");\n},\n},\n];\n}\n
"},{"location":"extensions/guides/main-extension/#addcatalogsource-and-removecatalogsource-methods","title":"addCatalogSource() and removeCatalogSource() Methods","text":"

The Main.LensExtension class also provides the addCatalogSource() and removeCatalogSource() methods, for managing custom catalog items (or entities). See the Catalog documentation for full details about the catalog.

"},{"location":"extensions/guides/protocol-handlers/","title":"Lens Protocol Handlers","text":"

Lens has a file association with the lens:// protocol. This means that Lens can be opened by external programs by providing a link that has lens as its protocol. Lens provides a routing mechanism that extensions can use to register custom handlers.

"},{"location":"extensions/guides/protocol-handlers/#registering-a-protocol-handler","title":"Registering A Protocol Handler","text":"

The field protocolHandlers exists both on LensMainExtension and on LensRendererExtension. This field will be iterated through every time a lens:// request gets sent to the application. The pathSchema argument must comply with the path-to-regexp package's compileToRegex function.

Once you have registered a handler it will be called when a user opens a link on their computer. Handlers will be run in both main and renderer in parallel with no synchronization between the two processes. Furthermore, both main and renderer are routed separately. In other words, which handler is selected in either process is independent from the list of possible handlers in the other.

Example of registering a handler:

import { Main, Common } from \"@k8slens/extensions\";\n\nfunction rootHandler(params: Common.Types.ProtocolRouteParams) {\nconsole.log(\"routed to ExampleExtension\", params);\n}\n\nexport default class ExampleExtensionMain extends Main.LensExtension {\nprotocolHandlers = [\npathSchema: \"/\",\nhandler: rootHandler,\n]\n}\n

For testing the routing of URIs the open (on macOS) or xdg-open (on most linux) CLI utilities can be used. For the above handler, the following URI would be always routed to it:

open lens://extension/example-extension/\n
"},{"location":"extensions/guides/protocol-handlers/#deregistering-a-protocol-handler","title":"Deregistering A Protocol Handler","text":"

All that is needed to deregister a handler is to remove it from the array of handlers.

"},{"location":"extensions/guides/protocol-handlers/#routing-algorithm","title":"Routing Algorithm","text":"

The routing mechanism for extensions is quite straight forward. For example consider an extension example-extension which is published by the @mirantis org. If it were to register a handler with \"/display/:type\" as its corresponding link then we would match the following URI like this:

Once matched, the handler would be called with the following argument (note both \"search\" and \"pathname\" will always be defined):

{\n\"search\": {\n\"text\": \"Hello\"\n},\n\"pathname\": {\n\"type\": \"notification\"\n}\n}\n

As the diagram above shows, the search (or query) params are not considered as part of the handler resolution. If the URI had instead been lens://extension/@mirantis/example-extension/display/notification/green then a third (and optional) field will have the rest of the path. The tail field would be filled with \"/green\". If multiple pathSchema's match a given URI then the most specific handler will be called.

For example consider the following pathSchema's:

  1. \"/\"
  2. \"/display\"
  3. \"/display/:type\"
  4. \"/show/:id\"

The URI sub-path \"/display\" would be routed to #2 since it is an exact match. On the other hand, the subpath \"/display/notification\" would be routed to #3.

The URI is routed to the most specific matching pathSchema. This way the \"/\" (root) pathSchema acts as a sort of catch all or default route if no other route matches.

"},{"location":"extensions/guides/renderer-extension/","title":"Renderer Extension (WIP)","text":"

The Renderer Extension API is the interface to Lens's renderer process. Lens runs in both the main and renderer processes. The Renderer Extension API allows you to access, configure, and customize Lens data, add custom Lens UI elements, protocol handlers, and command palette commands, as well as run custom code in Lens's renderer process.

The custom Lens UI elements that you can add include:

  • Cluster pages
  • Cluster page menus
  • Global pages
  • Welcome menus
  • App preferences
  • Top bar items
  • Status bar items
  • KubeObject menu items
  • KubeObject detail items
  • KubeObject status texts
  • Kube workloads overview items

as well as catalog-related UI elements:

  • Entity settings
  • Catalog entity detail items

All UI elements are based on React components.

Finally, you can also add commands and protocol handlers:

  • Command palette commands
  • protocol handlers
"},{"location":"extensions/guides/renderer-extension/#rendererlensextension-class","title":"Renderer.LensExtension Class","text":""},{"location":"extensions/guides/renderer-extension/#onactivate-and-ondeactivate-methods","title":"onActivate() and onDeactivate() Methods","text":"

To create a renderer extension, extend the Renderer.LensExtension class:

import { Renderer } from \"@k8slens/extensions\";\n\nexport default class ExampleExtensionMain extends Renderer.LensExtension {\nonActivate() {\nconsole.log(\"custom renderer process extension code started\");\n}\n\nonDeactivate() {\nconsole.log(\"custom renderer process extension de-activated\");\n}\n}\n

Two methods enable you to run custom code: onActivate() and onDeactivate(). Enabling your extension calls onActivate() and disabling your extension calls onDeactivate(). You can initiate custom code by implementing onActivate(). Implementing onDeactivate() gives you the opportunity to clean up after your extension.

Info

Disable extensions from the Lens Extensions page:

1. Navigate to **File** > **Extensions** in the top menu bar.\n(On Mac, it is **Lens** > **Extensions**.)\n2. For the extension you want to disable, open the context menu (click on the three vertical dots) and choose **Disable**.\n

The example above logs messages when the extension is enabled and disabled.

"},{"location":"extensions/guides/renderer-extension/#clusterpages","title":"clusterPages","text":"

Cluster pages appear in the cluster dashboard. Use cluster pages to display information about or add functionality to the active cluster. It is also possible to include custom details from other clusters. Use your extension to access Kubernetes resources in the active cluster with ClusterStore.getInstance().

Add a cluster page definition to a Renderer.LensExtension subclass with the following example:

import { Renderer } from \"@k8slens/extensions\";\nimport { ExampleIcon, ExamplePage } from \"./page\";\nimport React from \"react\";\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nclusterPages = [\n{\nid: \"hello\",\ncomponents: {\nPage: () => <ExamplePage extension={this} />,\n},\n},\n];\n}\n

clusterPages is an array of objects that satisfy the PageRegistration interface. The properties of the clusterPages array objects are defined as follows:

  • id is a string that identifies the page.
  • components matches the PageComponents interface for which there is one field, Page.
  • Page is of type React.ComponentType<any>. It offers flexibility in defining the appearance and behavior of your page.

ExamplePage in the example above can be defined in page.tsx:

import { Renderer } from \"@k8slens/extensions\";\nimport React from \"react\";\n\nexport class ExamplePage extends React.Component<{\nextension: LensRendererExtension;\n}> {\nrender() {\nreturn (\n<div>\n<p>Hello world!</p>\n</div>\n);\n}\n}\n

Note that the ExamplePage class defines the extension property. This allows the ExampleExtension object to be passed in the cluster page definition in the React style. This way, ExamplePage can access all ExampleExtension subclass data.

The above example shows how to create a cluster page, but not how to make that page available to the Lens user. Use clusterPageMenus, covered in the next section, to add cluster pages to the Lens UI.

"},{"location":"extensions/guides/renderer-extension/#clusterpagemenus","title":"clusterPageMenus","text":"

clusterPageMenus allows you to add cluster page menu items to the secondary left nav, below Lens's standard cluster menus like Workloads, Custom Resources, etc.

By expanding on the above example, you can add a cluster page menu item to the ExampleExtension definition:

import { Renderer } from \"@k8slens/extensions\";\nimport { ExampleIcon, ExamplePage } from \"./page\";\nimport React from \"react\";\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nclusterPages = [\n{\nid: \"hello\",\ncomponents: {\nPage: () => <ExamplePage extension={this} />,\n},\n},\n];\n\nclusterPageMenus = [\n{\ntarget: { pageId: \"hello\" },\ntitle: \"Hello World\",\ncomponents: {\nIcon: ExampleIcon,\n},\n},\n];\n}\n

clusterPageMenus is an array of objects that satisfy the ClusterPageMenuRegistration interface. This element defines how the cluster page menu item will appear and what it will do when you click it. The properties of the clusterPageMenus array objects are defined as follows:

  • target links to the relevant cluster page using pageId.
  • pageId takes the value of the relevant cluster page's id property.
  • title sets the name of the cluster page menu item that will appear in the left side menu.
  • components is used to set an icon that appears to the left of the title text in the left side menu.

The above example creates a menu item that reads Hello World. When users click Hello World, the cluster dashboard will show the contents of Example Page.

This example requires the definition of another React-based component, ExampleIcon, which has been added to page.tsx, as follows:

import { Renderer } from \"@k8slens/extensions\";\nimport React from \"react\";\n\ntype IconProps = Renderer.Component.IconProps;\n\nconst {\nComponent: { Icon },\n} = Renderer;\n\nexport function ExampleIcon(props: IconProps) {\nreturn <Icon {...props} material=\"pages\" tooltip={\"Hi!\"} />;\n}\n\nexport class ExamplePage extends React.Component<{\nextension: Renderer.LensExtension;\n}> {\nrender() {\nreturn (\n<div>\n<p>Hello world!</p>\n</div>\n);\n}\n}\n

Lens includes various built-in components available for extension developers to use. One of these is the Renderer.Component.Icon, introduced in ExampleIcon, which you can use to access any of the icons available at Material Design. The properties that Renderer.Component.Icon uses are defined as follows:

  • material takes the name of the icon you want to use.
  • tooltip sets the text you want to appear when a user hovers over the icon.

clusterPageMenus can also be used to define sub menu items, so that you can create groups of cluster pages. The following example groups two sub menu items under one parent menu item:

import { Renderer } from \"@k8slens/extensions\";\nimport { ExampleIcon, ExamplePage } from \"./page\";\nimport React from \"react\";\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nclusterPages = [\n{\nid: \"hello\",\ncomponents: {\nPage: () => <ExamplePage extension={this} />,\n},\n},\n{\nid: \"bonjour\",\ncomponents: {\nPage: () => <ExamplePage extension={this} />,\n},\n},\n];\n\nclusterPageMenus = [\n{\nid: \"example\",\ntitle: \"Greetings\",\ncomponents: {\nIcon: ExampleIcon,\n},\n},\n{\nparentId: \"example\",\ntarget: { pageId: \"hello\" },\ntitle: \"Hello World\",\ncomponents: {\nIcon: ExampleIcon,\n},\n},\n{\nparentId: \"example\",\ntarget: { pageId: \"bonjour\" },\ntitle: \"Bonjour le monde\",\ncomponents: {\nIcon: ExampleIcon,\n},\n},\n];\n}\n

The above defines two cluster pages and three cluster page menu objects. The cluster page definitions are straightforward. The three cluster page menu objects include one parent menu item and two sub menu items. The first cluster page menu object defines the parent of a foldout submenu. Setting the id field in a cluster page menu definition implies that it is defining a foldout submenu. Also note that the target field is not specified (it is ignored if the id field is specified). This cluster page menu object specifies the title and components fields, which are used in displaying the menu item in the cluster dashboard sidebar. Initially the submenu is hidden. Activating this menu item toggles on and off the appearance of the submenu below it. The remaining two cluster page menu objects define the contents of the submenu. A cluster page menu object is defined to be a submenu item by setting the parentId field to the id of the parent of a foldout submenu, \"example\" in this case.

This is what the example could look like, including how the menu item will appear in the secondary left nav:

"},{"location":"extensions/guides/renderer-extension/#globalpages","title":"globalPages","text":"

Global pages are independent of the cluster dashboard and can fill the entire Lens UI. Their primary use is to display information and provide functionality across clusters (or catalog entities), including customized data and functionality unique to your extension.

Unlike cluster pages, users can trigger global pages even when there is no active cluster (or catalog entity).

The following example defines a Renderer.LensExtension subclass with a single global page definition:

import { Renderer } from \"@k8slens/extensions\";\nimport { HelpPage } from \"./page\";\nimport React from \"react\";\n\nexport default class HelpExtension extends Renderer.LensExtension {\nglobalPages = [\n{\nid: \"help\",\ncomponents: {\nPage: () => <HelpPage extension={this} />,\n},\n},\n];\n}\n

globalPages is an array of objects that satisfy the PageRegistration interface. The properties of the globalPages array objects are defined as follows:

  • id is a string that identifies the page.
  • components matches the PageComponents interface for which there is one field, Page.
  • Page is of type React.ComponentType<any>. It offers flexibility in defining the appearance and behavior of your page.

HelpPage in the example above can be defined in page.tsx:

import { Renderer } from \"@k8slens/extensions\";\nimport React from \"react\";\n\nexport class HelpPage extends React.Component<{\nextension: LensRendererExtension;\n}> {\nrender() {\nreturn (\n<div>\n<p>Help yourself</p>\n</div>\n);\n}\n}\n

Note that the HelpPage class defines the extension property. This allows the HelpExtension object to be passed in the global page definition in the React-style. This way, HelpPage can access all HelpExtension subclass data.

This example code shows how to create a global page, but not how to make that page available to the Lens user. Global pages are typically made available in the following ways:

  • To add global pages to the top menu bar, see appMenus in the Main Extension guide.
  • To add global pages as an interactive element in the blue status bar along the bottom of the Lens UI, see statusBarItems.
  • To add global pages to the Welcome Page, see welcomeMenus.
"},{"location":"extensions/guides/renderer-extension/#welcomemenus","title":"welcomeMenus","text":""},{"location":"extensions/guides/renderer-extension/#apppreferences","title":"appPreferences","text":"

The Lens Preferences page is a built-in global page. You can use Lens extensions to add custom preferences to the Preferences page, providing a single location for users to configure global options.

The following example demonstrates adding a custom preference:

import { Renderer } from \"@k8slens/extensions\";\nimport {\nExamplePreferenceHint,\nExamplePreferenceInput,\n} from \"./src/example-preference\";\nimport { observable } from \"mobx\";\nimport React from \"react\";\n\nexport default class ExampleRendererExtension extends Renderer.LensExtension {\n@observable preference = { enabled: false };\n\nappPreferences = [\n{\ntitle: \"Example Preferences\",\ncomponents: {\nInput: () => <ExamplePreferenceInput preference={this.preference} />,\nHint: () => <ExamplePreferenceHint />,\n},\n},\n];\n}\n

appPreferences is an array of objects that satisfies the AppPreferenceRegistration interface. The properties of the appPreferences array objects are defined as follows:

  • title sets the heading text displayed on the Preferences page.
  • components specifies two React.Component objects that define the interface for the preference.
  • Input specifies an interactive input element for the preference.
  • Hint provides descriptive information for the preference, shown below the Input element.

Note

Note that the input and the hint can be comprised of more sophisticated elements, according to the needs of the extension.

ExamplePreferenceInput expects its React props to be set to an ExamplePreferenceProps instance. This is how ExampleRendererExtension handles the state of the preference input. ExampleRendererExtension has a preference field, which you will add to ExamplePreferenceInput.

In this example ExamplePreferenceInput, ExamplePreferenceHint, and ExamplePreferenceProps are defined in ./src/example-preference.tsx as follows:

import { Renderer } from \"@k8slens/extensions\";\nimport { makeObservable } from \"mobx\";\nimport { observer } from \"mobx-react\";\nimport React from \"react\";\n\nconst {\nComponent: { Checkbox },\n} = Renderer;\n\nexport class ExamplePreferenceProps {\npreference: {\nenabled: boolean;\n};\n}\n\n@observer\nexport class ExamplePreferenceInput extends React.Component<ExamplePreferenceProps> {\npublic constructor() {\nsuper({ preference: { enabled: false } });\nmakeObservable(this);\n}\n\nrender() {\nconst { preference } = this.props;\nreturn (\n<Checkbox\nlabel=\"I understand appPreferences\"\nvalue={preference.enabled}\nonChange={(v) => {\npreference.enabled = v;\n}}\n/>\n);\n}\n}\n\nexport class ExamplePreferenceHint extends React.Component {\nrender() {\nreturn <span>This is an example of an appPreference for extensions.</span>;\n}\n}\n

ExamplePreferenceInput implements a simple checkbox using Lens's Renderer.Component.Checkbox using the following properties:

  • label sets the text that displays next to the checkbox.
  • value is initially set to preference.enabled.
  • onChange is a function that responds when the state of the checkbox changes.

ExamplePreferenceInput is defined with the ExamplePreferenceProps React props. This is an object with the single enabled property. It is used to indicate the state of the preference, and it is bound to the checkbox state in onChange.

ExamplePreferenceHint is a simple text span.

The above example introduces the decorators makeObservable and observer from the mobx and mobx-react packages. mobx simplifies state management. Without it, this example would not visually update the checkbox properly when the user activates it. Lens uses mobx extensively for state management of its own UI elements. We recommend that extensions rely on it, as well. Alternatively, you can use React's state management, though mobx is typically simpler to use.

Note that you can manage an extension's state data using an ExtensionStore object, which conveniently handles persistence and synchronization. To simplify this guide, the example above defines a preference field in the ExampleRendererExtension class definition to hold the extension's state. However, we recommend that you manage your extension's state data using ExtensionStore.

"},{"location":"extensions/guides/renderer-extension/#topbaritems","title":"topBarItems","text":""},{"location":"extensions/guides/renderer-extension/#statusbaritems","title":"statusBarItems","text":"

The status bar is the blue strip along the bottom of the Lens UI. statusBarItems are React.ReactNode types. They can be used to display status information, or act as links to global pages as well as external pages.

The following example adds a statusBarItems definition and a globalPages definition to a LensRendererExtension subclass. It configures the status bar item to navigate to the global page upon activation (normally a mouse click):

import { Renderer } from \"@k8slens/extensions\";\nimport { HelpIcon, HelpPage } from \"./page\";\nimport React from \"react\";\n\nexport default class HelpExtension extends Renderer.LensExtension {\nglobalPages = [\n{\nid: \"help\",\ncomponents: {\nPage: () => <HelpPage extension={this} />,\n},\n},\n];\n\nstatusBarItems = [\n{\ncomponents: {\nItem: () => (\n<div\nclassName=\"flex align-center gaps\"\nonClick={() => this.navigate(\"help\")}\n>\n<HelpIcon />\nMy Status Bar Item\n</div>\n),\n},\n},\n];\n}\n

The properties of the statusBarItems array objects are defined as follows:

  • Item specifies the React.Component that will be shown on the status bar. By default, items are added starting from the right side of the status bar. Due to limited space in the status bar, Item will typically specify only an icon or a short string of text. The example above reuses the HelpIcon from the globalPageMenus guide.
  • onClick determines what the statusBarItem does when it is clicked. In the example, onClick is set to a function that calls the LensRendererExtension navigate() method. navigate takes the id of the associated global page as a parameter. Thus, clicking the status bar item activates the associated global pages.
"},{"location":"extensions/guides/renderer-extension/#kubeobjectmenuitems","title":"kubeObjectMenuItems","text":"

An extension can add custom menu items (kubeObjectMenuItems) for specific Kubernetes resource kinds and apiVersions. kubeObjectMenuItems appear under the vertical ellipsis for each listed resource in the cluster dashboard:

They also appear on the title bar of the details page for specific resources:

The following example shows how to add a kubeObjectMenuItems for namespace resources with an associated action:

import React from \"react\";\nimport { Renderer } from \"@k8slens/extensions\";\nimport { NamespaceMenuItem } from \"./src/namespace-menu-item\";\n\ntype KubeObjectMenuProps = Renderer.Component.KubeObjectMenuProps;\ntype Namespace = Renderer.K8sApi.Namespace;\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nkubeObjectMenuItems = [\n{\nkind: \"Namespace\",\napiVersions: [\"v1\"],\ncomponents: {\nMenuItem: (props: KubeObjectMenuProps<Namespace>) => (\n<NamespaceMenuItem {...props} />\n),\n},\n},\n];\n}\n

kubeObjectMenuItems is an array of objects matching the KubeObjectMenuRegistration interface. The example above adds a menu item for namespaces in the cluster dashboard. The properties of the kubeObjectMenuItems array objects are defined as follows:

  • kind specifies the Kubernetes resource type the menu item will apply to.
  • apiVersion specifies the Kubernetes API version number to use with the resource type.
  • components defines the menu item's appearance and behavior.
  • MenuItem provides a function that returns a React.Component given a set of menu item properties. In this example a NamespaceMenuItem object is returned.

NamespaceMenuItem is defined in ./src/namespace-menu-item.tsx:

import React from \"react\";\nimport { Renderer } from \"@k8slens/extensions\";\n\nconst {\nComponent: { terminalStore, MenuItem, Icon },\nNavigation,\n} = Renderer;\n\ntype KubeObjectMenuProps = Renderer.Component.KubeObjectMenuProps;\ntype Namespace = Renderer.K8sApi.Namespace;\n\nexport function NamespaceMenuItem(props: KubeObjectMenuProps<Namespace>) {\nconst { object: namespace, toolbar } = props;\nif (!namespace) return null;\n\nconst namespaceName = namespace.getName();\n\nconst sendToTerminal = (command: string) => {\nterminalStore.sendCommand(command, {\nenter: true,\nnewTab: true,\n});\nNavigation.hideDetails();\n};\n\nconst getPods = () => {\nsendToTerminal(`kubectl get pods -n ${namespaceName}`);\n};\n\nreturn (\n<MenuItem onClick={getPods}>\n<Icon\nmaterial=\"speaker_group\"\ninteractive={toolbar}\ntitle=\"Get pods in terminal\"\n/>\n<span className=\"title\">Get Pods</span>\n</MenuItem>\n);\n}\n

NamespaceMenuItem returns a Renderer.Component.MenuItem which defines the menu item's appearance and its behavior when activated via the onClick property. In the example, getPods() opens a terminal tab and runs kubectl to get a list of pods running in the current namespace.

The name of the namespace is retrieved from props passed into NamespaceMenuItem(). namespace is the props.object, which is of type Renderer.K8sApi.Namespace. Renderer.K8sApi.Namespace is the API for accessing namespaces. The current namespace in this example is simply given by namespace.getName(). Thus, kubeObjectMenuItems afford convenient access to the specific resource selected by the user.

"},{"location":"extensions/guides/renderer-extension/#kubeobjectdetailitems","title":"kubeObjectDetailItems","text":"

An extension can add custom details (kubeObjectDetailItems) for specified Kubernetes resource kinds and apiVersions. These custom details appear on the details page for a specific resource, such as a Namespace as shown here:

The following example shows how to use kubeObjectDetailItems to add a tabulated list of pods to the Namespace resource details page:

import React from \"react\";\nimport { Renderer } from \"@k8slens/extensions\";\nimport { NamespaceDetailsItem } from \"./src/namespace-details-item\";\n\ntype KubeObjectMenuProps = Renderer.Component.KubeObjectMenuProps;\ntype KubeObjectDetailsProps = Renderer.Component.KubeObjectDetailsProps;\ntype Namespace = Renderer.K8sApi.Namespace;\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nkubeObjectDetailItems = [\n{\nkind: \"Namespace\",\napiVersions: [\"v1\"],\npriority: 10,\ncomponents: {\nDetails: (props: KubeObjectDetailsProps<Namespace>) => (\n<NamespaceDetailsItem {...props} />\n),\n},\n},\n];\n}\n

kubeObjectDetailItems is an array of objects matching the KubeObjectDetailRegistration interface. This example above adds a detail item for namespaces in the cluster dashboard. The properties of the kubeObjectDetailItems array objects are defined as follows:

  • kind specifies the Kubernetes resource type the detail item will apply to.
  • apiVersion specifies the Kubernetes API version number to use with the resource type.
  • components defines the detail item's appearance and behavior.
  • Details provides a function that returns a React.Component given a set of detail item properties. In this example a NamespaceDetailsItem object is returned.

NamespaceDetailsItem is defined in ./src/namespace-details-item.tsx:

import { Renderer } from \"@k8slens/extensions\";\nimport { PodsDetailsList } from \"./pods-details-list\";\nimport React from \"react\";\nimport { observable } from \"mobx\";\nimport { observer } from \"mobx-react\";\n\nconst {\nK8sApi: { podsApi },\nComponent: { DrawerTitle },\n} = Renderer;\n\ntype KubeObjectMenuProps = Renderer.Component.KubeObjectMenuProps;\ntype Namespace = Renderer.K8sApi.Namespace;\ntype Pod = Renderer.K8sApi.Pod;\n\n@observer\nexport class NamespaceDetailsItem extends React.Component<\nKubeObjectDetailsProps<Namespace>\n> {\n@observable private pods: Pod[];\n\nasync componentDidMount() {\nconst namespace = this.props.object.getName();\n\nthis.pods = await podsApi.list({ namespace });\n}\n\nrender() {\nreturn (\n<div>\n<DrawerTitle>Pods</DrawerTitle>\n<PodsDetailsList pods={this.pods} />\n</div>\n);\n}\n}\n

Since NamespaceDetailsItem extends React.Component<KubeObjectDetailsProps<Namespace>>, it can access the current namespace object (type Namespace) through this.props.object. You can query this object for many details about the current namespace. In the example above, componentDidMount() gets the namespace's name using the Namespace getName() method. Use the namespace's name to limit the list of pods only to those in the relevant namespace. To get this list of pods, this example uses the Kubernetes pods API podsApi.list() method. The podsApi is automatically configured for the active cluster.

Note that podsApi.list() is an asynchronous method. Getting the pods list should occur prior to rendering the NamespaceDetailsItem. It is a common technique in React development to await async calls in componentDidMount(). However, componentDidMount() is called right after the first call to render(). In order to effect a subsequent render() call, React must be made aware of a state change. Like in the appPreferences guide, mobx and mobx-react are used to ensure NamespaceDetailsItem renders when the pods list updates. This is done simply by marking the pods field as an observable and the NamespaceDetailsItem class itself as an observer.

Finally, the NamespaceDetailsItem renders using the render() method. Details are placed in drawers, and using Renderer.Component.DrawerTitle provides a separator from details above this one. Multiple details in a drawer can be placed in <Renderer.Component.DrawerItem> elements for further separation, if desired. The rest of this example's details are defined in PodsDetailsList, found in ./pods-details-list.tsx:

import React from \"react\";\nimport { Renderer } from \"@k8slens/extensions\";\n\nconst {\nComponent: { TableHead, TableRow, TableCell, Table },\n} = Renderer;\n\ntype Pod = Renderer.K8sApi.Pod;\n\ninterface PodsDetailsListProps {\npods?: Pod[];\n}\n\nexport class PodsDetailsList extends React.Component<PodsDetailsListProps> {\ngetTableRow = (pod: Pod) => {\nreturn (\n<TableRow key={index} nowrap>\n<TableCell className=\"podName\">{pods[index].getName()}</TableCell>\n<TableCell className=\"podAge\">{pods[index].getAge()}</TableCell>\n<TableCell className=\"podStatus\">{pods[index].getStatus()}</TableCell>\n</TableRow>\n);\n};\n\nrender() {\nconst { pods } = this.props;\n\nif (!pods?.length) {\nreturn null;\n}\n\nreturn (\n<div>\n<Table>\n<TableHead>\n<TableCell className=\"podName\">Name</TableCell>\n<TableCell className=\"podAge\">Age</TableCell>\n<TableCell className=\"podStatus\">Status</TableCell>\n</TableHead>\n{pods.map(this.getTableRow)}\n</Table>\n</div>\n);\n}\n}\n

PodsDetailsList produces a simple table showing a list of the pods found in this namespace:

Obtain the name, age, and status for each pod using the Renderer.K8sApi.Pod methods. Construct the table using the Renderer.Component.Table and related elements.

For each pod the name, age, and status are obtained using the Renderer.K8sApi.Pod methods. The table is constructed using the Renderer.Component.Table and related elements. See Component documentation for further details.

"},{"location":"extensions/guides/renderer-extension/#kubeobjectstatustexts","title":"kubeObjectStatusTexts","text":""},{"location":"extensions/guides/renderer-extension/#kubeworkloadsoverviewitems","title":"kubeWorkloadsOverviewItems","text":""},{"location":"extensions/guides/renderer-extension/#entitysettings","title":"entitySettings","text":""},{"location":"extensions/guides/renderer-extension/#catalogentitydetailitems","title":"catalogEntityDetailItems","text":""},{"location":"extensions/guides/renderer-extension/#commandpalettecommands","title":"commandPaletteCommands","text":""},{"location":"extensions/guides/renderer-extension/#protocolhandlers","title":"protocolHandlers","text":"

See the Protocol Handlers Guide

"},{"location":"extensions/guides/resource-stack/","title":"Resource Stack (Cluster Feature)","text":"

A cluster feature is a set of Kubernetes resources that can be applied to and managed within the active cluster. The Renderer.K8sApi.ResourceStack class provides the functionality to input and apply kubernetes resources to a cluster. It is up to the extension developer to manage the life cycle of the resource stack. It could be applied automatically to a cluster by the extension, or the end-user could be required to install it.

The code examples in this section show how to create a resource stack, and define a cluster feature that is configurable from the cluster Settings page.

Info

To access the cluster Settings page, right-click the relevant cluster in the left side menu and click Settings.

The resource stack in this example consists of a single kubernetes resource:

apiVersion: v1\nkind: Pod\nmetadata:\nname: example-pod\nspec:\ncontainers:\n- name: example-pod\nimage: nginx\n

It is simply a pod named example-pod, running nginx. Assume this content is in the file ../resources/example-pod.yml.

The following code sample shows how to use the Renderer.K8sApi.ResourceStack to manage installing and uninstalling this resource stack:

import { Renderer, Common } from \"@k8slens/extensions\";\nimport * as path from \"path\";\n\nconst {\nK8sApi: {\nResourceStack,\nforCluster,\nPod,\n}\n} = Renderer;\n\ntype ResourceStack = Renderer.K8sApi.ResourceStack;\ntype Pod = Renderer.K8sApi.Pod;\ntype KubernetesCluster = Common.Catalog.KubernetesCluster;\n\nexport class ExampleClusterFeature {\nprotected stack: ResourceStack;\n\nconstructor(protected cluster: KubernetesCluster) {\nthis.stack = new ResourceStack(cluster, \"example-resource-stack\");\n}\n\nget resourceFolder() {\nreturn path.join(__dirname, \"../resources/\");\n}\n\ninstall(): Promise<string> {\nconsole.log(\"installing example-pod\");\nreturn this.stack.kubectlApplyFolder(this.resourceFolder);\n}\n\nasync isInstalled(): Promise<boolean> {\ntry {\nconst podApi = forCluster(this.cluster, Pod);\nconst examplePod = await podApi.get({name: \"example-pod\", namespace: \"default\"});\n\nif (examplePod?.kind) {\nconsole.log(\"found example-pod\");\nreturn true;\n}\n} catch(e) {\nconsole.log(\"Error getting example-pod:\", e);\n}\nconsole.log(\"didn't find example-pod\");\n\nreturn false;\n}\n\nasync uninstall(): Promise<string> {\nconsole.log(\"uninstalling example-pod\");\nreturn this.stack.kubectlDeleteFolder(this.resourceFolder);\n}\n}\n

The ExampleClusterFeature class constructor takes a Common.Catalog.KubernetesCluster argument. This is the cluster that the resource stack will be applied to, and the constructor instantiates a Renderer.K8sApi.ResourceStack as such. ExampleClusterFeature implements an install() method which simply invokes the kubectlApplyFolder() method of the Renderer.K8sApi.ResourceStack class. kubectlApplyFolder() applies to the cluster all kubernetes resources found in the folder passed to it, in this case ../resources. Similarly, ExampleClusterFeature implements an uninstall() method which simply invokes the kubectlDeleteFolder() method of the Renderer.K8sApi.ResourceStack class. kubectlDeleteFolder() tries to delete from the cluster all kubernetes resources found in the folder passed to it, again in this case ../resources.

ExampleClusterFeature also implements an isInstalled() method, which demonstrates how you can utilize the kubernetes api to inspect the resource stack status. isInstalled() simply tries to find a pod named example-pod, as a way to determine if the pod is already installed. This method can be useful in creating a context-sensitive UI for installing/uninstalling the feature, as demonstrated in the next sample code.

To allow the end-user to control the life cycle of this cluster feature the following code sample shows how to implement a user interface based on React and custom Lens UI components:

 import React from \"react\";\nimport { Common, Renderer } from \"@k8slens/extensions\";\nimport { observer } from \"mobx-react\";\nimport { computed, observable, makeObservable } from \"mobx\";\nimport { ExampleClusterFeature } from \"./example-cluster-feature\";\n\nconst {\nComponent: {\nSubTitle, Button,\n}\n} = Renderer;\n\ninterface ExampleClusterFeatureSettingsProps {\ncluster: Common.Catalog.KubernetesCluster;\n}\n\n@observer\nexport class ExampleClusterFeatureSettings extends React.Component<ExampleClusterFeatureSettingsProps> {\nconstructor(props: ExampleClusterFeatureSettingsProps) {\nsuper(props);\nmakeObservable(this);\n}\n\n@observable installed = false;\n@observable inProgress = false;\n\nfeature: ExampleClusterFeature;\n\nasync componentDidMount() {\nthis.feature = new ExampleClusterFeature(this.props.cluster);\n\nawait this.updateFeatureState();\n}\n\nasync updateFeatureState() {\nthis.installed = await this.feature.isInstalled();\n}\n\nasync save() {\nthis.inProgress = true;\n\ntry {\nif (this.installed) {\nawait this.feature.uninstall();\n} else {\nawait this.feature.install();\n}\n} finally {\nthis.inProgress = false;\n\nawait this.updateFeatureState();\n}\n}\n\n@computed get buttonLabel()\u00a0{\nif (this.inProgress && this.installed) return \"Uninstalling ...\";\nif (this.inProgress) return \"Applying ...\";\n\nif (this.installed) {\nreturn \"Uninstall\";\n}\n\nreturn \"Apply\";\n}\n\nrender() {\nreturn (\n<>\n<section>\n<SubTitle title=\"Example Cluster Feature using a Resource Stack\" />\n<Button\nlabel={this.buttonLabel}\nwaiting={this.inProgress}\nonClick={() => this.save()}\nprimary />\n</section>\n</>\n);\n}\n}\n

The ExampleClusterFeatureSettings class extends React.Component and simply renders a subtitle and a button. ExampleClusterFeatureSettings takes the cluster as a prop and when the React component has mounted the ExampleClusterFeature is instantiated using this cluster (in componentDidMount()). The rest of the logic concerns the button appearance and action, based on the ExampleClusterFeatureSettings fields installed and inProgress. The installed value is of course determined using the aforementioned ExampleClusterFeature method isInstalled(). The inProgress value is true while waiting for the feature to be installed (or uninstalled).

Note that the button is a Renderer.Component.Button element and this example takes advantage of its waiting prop to show a \"waiting\" animation while the install (or uninstall) is in progress. Using elements from Renderer.Component is encouraged, to take advantage of their built-in properties, and to ensure a common look and feel.

Also note that MobX 6 is used for state management, ensuring that the UI is rerendered when state has changed. The ExampleClusterFeatureSettings class is marked as an @observer, and its constructor must call makeObservable(). As well, the installed and inProgress fields are marked as @observable, ensuring that the button gets rerendered any time these fields change.

Finally, ExampleClusterFeatureSettings needs to be connected to the extension, and would typically appear on the cluster Settings page via a Renderer.LensExtension.entitySettings entry. The ExampleExtension would look like this:

import { Common, Renderer } from \"@k8slens/extensions\";\nimport { ExampleClusterFeatureSettings } from \"./src/example-cluster-feature-settings\"\nimport React from \"react\"\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nentitySettings = [\n{\napiVersions: [\"entity.k8slens.dev/v1alpha1\"],\nkind: \"KubernetesCluster\",\ntitle: \"Example Cluster Feature\",\npriority: 5,\ncomponents: {\nView: ({ entity = null }: { entity: Common.Catalog.KubernetesCluster}) => (\n<ExampleClusterFeatureSettings cluster={entity} />\n)\n}\n}\n];\n\n}\n

An entity setting is added to the entitySettings array field of the Renderer.LensExtension class. Because Lens's catalog can contain different kinds of entities, the kind must be identified. For more details about the catalog see the Catalog Guide. Clusters are a built-in kind, so the apiVersions and kind fields should be set as above. The title is shown as a navigation item on the cluster Settings page and the components.View is displayed when the navigation item is clicked on. The components.View definition above shows how the ExampleClusterFeatureSettings element is included, and how its cluster prop is set. priority determines the order of the entity settings, the higher the number the higher in the navigation panel the setting is placed. The default value is 50.

The final result looks like this:

ExampleClusterFeature and ExampleClusterFeatureSettings demonstrate a cluster feature for a simple resource stack. In practice a resource stack can include many resources, and require more sophisticated life cycle management (upgrades, partial installations, etc.) Using Renderer.K8sApi.ResourceStack and entitySettings it is possible to implement solutions for more complex cluster features. The Lens Metrics setting (on the cluster Settings page) is a good example of an advanced solution.

"},{"location":"extensions/guides/stores/","title":"Stores","text":"

Stores are components that persist and synchronize state data. Lens uses a number of stores to maintain various kinds of state information, including:

  • The ClusterStore manages cluster state data (such as cluster details), and it tracks which cluster is active.
  • The WorkspaceStore manages workspace state data (such as the workspace name), and and it tracks which clusters belong to a given workspace.
  • The ExtensionStore manages custom extension state data.

This guide focuses on the ExtensionStore.

"},{"location":"extensions/guides/stores/#extensionstore","title":"ExtensionStore","text":"

Extension developers can create their own store for managing state data by extending the ExtensionStore class. This guide shows how to create a store for the appPreferences guide example, which demonstrates how to add a custom preference to the Preferences page. The preference is a simple boolean that indicates whether or not something is enabled. However, in the example, the enabled state is not stored anywhere, and it reverts to the default when Lens is restarted.

Store.ExtensionStore's child class will need to be created before being used. It is recommended to call the inherited static method getInstanceOrCreate() only in one place, generally within you extension's onActivate() method. It is also recommenced to delete the instance, using the inherited static method resetInstance(), in your extension's onDeactivate() method. Everywhere else in your code you should use the getInstance() static method. This is so that your data is kept up to date and not persisted longer than expected.

The following example code creates a store for the appPreferences guide example:

import { Common } from \"@k8slens/extensions\";\nimport { observable, makeObservable } from \"mobx\";\n\nexport type ExamplePreferencesModel = {\nenabled: boolean;\n};\n\nexport class ExamplePreferencesStore extends Common.Store.ExtensionStore<ExamplePreferencesModel> {\n\n@observable  enabled = false;\n\nprivate constructor() {\nsuper({\nconfigName: \"example-preferences-store\",\ndefaults: {\nenabled: false\n}\n});\nmakeObservable(this);\n}\n\nprotected fromStore({ enabled }: ExamplePreferencesModel): void {\nthis.enabled = enabled;\n}\n\ntoJSON(): ExamplePreferencesModel {\nreturn {\nenabled: this.enabled\n};\n}\n}\n

First, our example defines the extension's data model using the simple ExamplePreferencesModel type. This has a single field, enabled, which represents the preference's state. ExamplePreferencesStore extends Store.ExtensionStore, which is based on the ExamplePreferencesModel. The enabled field is added to the ExamplePreferencesStore class to hold the \"live\" or current state of the preference. Note the use of the observable decorator on the enabled field. The appPreferences guide example uses MobX for the UI state management, ensuring the checkbox updates when it's activated by the user.

Next, our example implements the constructor and two abstract methods. The constructor specifies the name of the store (\"example-preferences-store\") and the default (initial) value for the preference state (enabled: false). Lens internals call the fromStore() method when the store loads. It gives the extension the opportunity to retrieve the stored state data values based on the defined data model. The enabled field of the ExamplePreferencesStore is set to the value from the store whenever fromStore() is invoked. The toJSON() method is complementary to fromStore(). It is called when the store is being saved. toJSON() must provide a JSON serializable object, facilitating its storage in JSON format.

Finally, ExamplePreferencesStore is created by calling ExamplePreferencesStore.getInstanceOrCreate(), and exported for use by other parts of the extension. Note that ExamplePreferencesStore is a singleton. Calling this function will create an instance if one has not been made before. Through normal use you should call ExamplePreferencesStore.getInstance() as that will throw an error if an instance does not exist. This provides some logical safety in that it limits where a new instance can be created. Thus it prevents an instance from being created when the constructor args are not present at the call site.

If you are doing some cleanup it is recommended to call ExamplePreferencesStore.getInstance(false) which returns undefined instead of throwing when there is no instance.

The following example code, modified from the appPreferences guide demonstrates how to use the extension store. ExamplePreferencesStore must be loaded in the main process, where loaded stores are automatically saved when exiting Lens. This can be done in ./main.ts:

import { Main } from \"@k8slens/extensions\";\nimport { ExamplePreferencesStore } from \"./src/example-preference-store\";\n\nexport default class ExampleMainExtension extends Main.LensExtension {\nasync onActivate() {\nawait ExamplePreferencesStore.getInstanceOrCreate().loadExtension(this);\n}\n}\n

Here, ExamplePreferencesStore loads with ExamplePreferencesStore.getInstanceOrCreate().loadExtension(this), which is conveniently called from the onActivate() method of ExampleMainExtension. Similarly, ExamplePreferencesStore must load in the renderer process where the appPreferences are handled. This can be done in ./renderer.ts:

import { Renderer } from \"@k8slens/extensions\";\nimport { ExamplePreferenceHint, ExamplePreferenceInput } from \"./src/example-preference\";\nimport { ExamplePreferencesStore } from \"./src/example-preference-store\";\nimport React from \"react\";\n\nexport default class ExampleRendererExtension extends Renderer.LensExtension {\n\nasync onActivate() {\nawait ExamplePreferencesStore.getInstanceOrCreate().loadExtension(this);\n}\n\nappPreferences = [\n{\ntitle: \"Example Preferences\",\ncomponents: {\nInput: () => <ExamplePreferenceInput />,\nHint: () => <ExamplePreferenceHint/>\n}\n}\n];\n}\n

Again, ExamplePreferencesStore.getInstanceOrCreate().loadExtension(this) is called to load ExamplePreferencesStore, this time from the onActivate() method of ExampleRendererExtension.

ExamplePreferenceInput is defined in ./src/example-preference.tsx:

import { Renderer } from \"@k8slens/extensions\";\nimport { observer } from \"mobx-react\";\nimport React from \"react\";\nimport { ExamplePreferencesStore } from \"./example-preference-store\";\n\nconst {\nComponent: {\nCheckbox,\n},\n} = Renderer;\n\n@observer\nexport class ExamplePreferenceInput extends React.Component {\n\nrender() {\nreturn (\n<Checkbox\nlabel=\"I understand appPreferences\"\nvalue={ExamplePreferencesStore.getInstance().enabled}\nonChange={v => { ExamplePreferencesStore.getInstance().enabled = v; }}\n/>\n);\n}\n}\n\nexport class ExamplePreferenceHint extends React.Component {\nrender() {\nreturn (\n<span>This is an example of an appPreference for extensions.</span>\n);\n}\n}\n

The only change here is that ExamplePreferenceProps defines its preference field as an ExamplePreferencesStore type. Everything else works as before, except that now the enabled state persists across Lens restarts because it is managed by the ExamplePreferencesStore.

"},{"location":"extensions/guides/working-with-mobx/","title":"Working with MobX","text":""},{"location":"extensions/guides/working-with-mobx/#introduction","title":"Introduction","text":"

Lens uses MobX on top of React's state management system. The result is a more declarative state management style, rather than React's native setState mechanism.

You can review how React handles state management here.

The following is a quick overview:

  • React.Component is generic with respect to both props and state (which default to the empty object type).
  • props should be considered read-only from the point of view of the component, and it is the mechanism for passing in arguments to a component.
  • state is a component's internal state, and can be read by accessing the super-class field state.
  • state must be updated using the setState parent method which merges the new data with the old state.
  • React does some optimizations around re-rendering components after quick successions of setState calls.
"},{"location":"extensions/guides/working-with-mobx/#how-mobx-works","title":"How MobX Works:","text":"

MobX is a package that provides an abstraction over React's state management system. The three main concepts are:

  • observable is a marker for data stored in the component's state.
  • action is a function that modifies any observable data.
  • computed is a marker for data that is derived from observable data, but that is not actually stored. Think of this as computing isEmpty rather than an observable field called count.

Further reading is available on the MobX website.

"},{"location":"extensions/testing-and-publishing/publishing/","title":"Publishing Extensions","text":"

To be able to easily share extensions with users they need to be published somewhere. Lens currently only supports installing extensions from NPM tarballs. All hosted extensions must, therefore, be retrievable in a NPM tarball.

"},{"location":"extensions/testing-and-publishing/publishing/#places-to-host-your-extension","title":"Places To Host Your Extension","text":"

We recommend to host your extension somewhere on the web so that it is easy for people to search for and download it. We recommend either hosting it as an NPM package on https://www.npmjs.com or through GitHub releases. We recommend against using GitHub packages (https://github.com/features/packages) as it requires a GitHub token to access the package.

"},{"location":"extensions/testing-and-publishing/publishing/#publishing-via-npm","title":"Publishing via NPM","text":"

This is the easiest method of publishing as NPM comes built in with mechanism to get a link to download the package as a tarball. Once you have set up an account with NPM (https://www.npmjs.com/signup) and logged in with their CLI (npm login) you will be ready to publish.

  • Run npm version <major|minor|patch> to bump the version of your extension by the appropriate amount.
  • Run npm publish to publish your extension to NPM
  • Run git push && git push --tags to push the commit that NPM creates to your git remote.

It is probably a good idea to put into your README.md the following instructions for your users to get the tarball download link.

npm view <extension-name> dist.tarball\n

This will output the link that they will need to give to Lens to install your extension.

"},{"location":"extensions/testing-and-publishing/publishing/#publish-via-github-releases","title":"Publish via GitHub Releases","text":"

Another method of publishing your extensions is to do so with the releases mechanism built into GitHub. We recommend reading GitHub's Releases Documentation for how to actually do the steps of a release. The following will be a quick walk through on how to make the tarball which will be the released file.

"},{"location":"extensions/testing-and-publishing/publishing/#making-a-npm-tarball-of-your-extension","title":"Making a NPM Tarball of Your Extension","text":"

While this is necessary for hosting on GitHub releases, this is also the means for creating a tarball if you plan on hosting on a different file hosting platform.

Say you have your project folder at ~/my-extension/ and you want to create an NPM package we need to do the following within your git repo:

npm pack\n

This will create a NPM tarball that can be hosted on GitHub Releases or any other publicly available file hosting service.

"},{"location":"extensions/testing-and-publishing/testing/","title":"Testing Extensions","text":""},{"location":"extensions/testing-and-publishing/testing/#renderer-process-unit-testing","title":"Renderer Process Unit Testing","text":"

UI components in the extension's renderer process are based on React/ReactDOM. These components can be tested by popular React testing tools like React Testing Library.

If you are using the Yeoman Lens Extension Generator to scaffold extension project then the testing environment for render process is already set up for you. Just use npm start or yarn test to run the tests.

For example, I have a component GlobalPageMenuIcon and want to test if props.navigate is called when user clicks the icon.

My component GlobalPageMenuIcon

import React from \"react\"\nimport { Renderer } from \"@k8slens/extensions\";\n\nconst {\nComponent: {\nIcon,\n},\n} = Renderer;\n\nconst GlobalPageMenuIcon = ({ navigate }: { navigate?: () => void }): JSX.Element => (\n<Icon\nmaterial=\"trip_origin\"\nonClick={() => navigate()}\ndata-testid=\"global-page-menu-icon\"\n/>\n)\n

The test

import React from \"react\"\nimport { render, screen, fireEvent } from \"@testing-library/react\";\n\nimport GlobalPageMenuIcon from \"./GlobalPageMenuIcon\";\n\ntest(\"click called navigate()\", () => {\nconst navigate = jest.fn();\nrender(<GlobalPageMenuIcon navigate={navigate} />);\nfireEvent.click(screen.getByTestId(\"global-page-menu-icon\"));\nexpect(navigate).toHaveBeenCalled();\n});\n

In the example we used React Testing Library but any React testing framework can be used to test renderer process UI components.

There are more example tests in the generator's template. Extend your tests based on the examples.

"},{"location":"extensions/testing-and-publishing/testing/#main-process-unit-testing","title":"Main Process Unit Testing","text":"

Code in the extension's main process consists of normal JavaScript files that have access to extension api, you can write unit tests using any testing framework.

If you are using the Yeoman Lens Extension Generator to scaffold your extension project then the Jest testing environment is set up for you. Just use npm start or yarn test to run the tests.

"},{"location":"extensions/testing-and-publishing/testing/#tips","title":"Tips","text":""},{"location":"extensions/testing-and-publishing/testing/#consolelog","title":"Console.log","text":"

Extension developers might find console.log() useful for printing out information and errors from extensions. To use console.log(), note that Lens is based on Electron, and that Electron has two types of processes: Main and Renderer.

"},{"location":"extensions/testing-and-publishing/testing/#renderer-process-logs","title":"Renderer Process Logs","text":"

In the Renderer process, console.log() is printed in the Console in Developer Tools (View > Toggle Developer Tools).

"},{"location":"extensions/testing-and-publishing/testing/#main-process-logs","title":"Main Process Logs","text":"

Viewing the logs from the Main process is a little trickier, since they cannot be printed using Developer Tools.

"},{"location":"extensions/testing-and-publishing/testing/#macos","title":"macOS","text":"

On macOS, view the Main process logs by running Lens from the terminal:

/Applications/Lens.app/Contents/MacOS/Lens\n

You can also use Console.app to view the Main process logs.

"},{"location":"extensions/testing-and-publishing/testing/#linux","title":"Linux","text":"

On Linux, you can access the Main process logs using the Lens PID. First get the PID:

ps aux | grep Lens | grep -v grep\n

Then get the Main process logs using the PID:

tail -f /proc/[pid]/fd/1 # stdout (console.log)\ntail -f /proc/[pid]/fd/2 # stdout (console.error)\n
"},{"location":"extensions/usage/","title":"Using Extensions","text":"

The features that Lens includes out-of-the-box are just the start. Lens extensions let you add new features to your installation to support your workflow. Rich extensibility model lets extension authors plug directly into the Lens UI and contribute functionality through the same APIs used by Lens itself. The start using Lens Extensions go to File (or Lens on macOS) > Extensions in the application menu. This is the Extensions management page where all the management of the extensions you want to use is done.

"},{"location":"extensions/usage/#installing-an-extension","title":"Installing an Extension","text":"

There are three ways to install extensions. If you have the extension as a .tgz file then dragging and dropping it in the extension management page will install it for you. If it is hosted on the web, you can paste the URL and click Install and Lens will download and install it. The third way is to move the extension into your ~/.k8slens/extensions (or C:\\Users\\<user>\\.k8slens\\extensions) folder and Lens will automatically detect it and install the extension.

"},{"location":"extensions/usage/#enabling-or-disabling-an-extension","title":"Enabling or Disabling an Extension","text":"

Go to the extension management page and click either the Enable or Disable buttons. Extensions will be enabled by default when you first install them. A disabled extension is not loaded by Lens and is not run.

"},{"location":"extensions/usage/#uninstalling-an-extension","title":"Uninstalling an Extension","text":"

If, for whatever reason, you wish to remove the installation of an extension simple click the Uninstall button. This will remove all the files that Lens would need to run the extension.

"}]} \ No newline at end of file +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Lens Extension API","text":"

Customize and enhance the Lens experience with the Lens Extension API. Use the extension API to create menus or page content. The same extension API was used to create many of Lens's core features. To install your first extension you should goto the extension page in lens.

This documentation describes:

  • How to build, run, test, and publish an extension.
  • How to take full advantage of the Lens Extension API.
  • Where to find guides and code samples to help get you started.
"},{"location":"#what-extensions-can-do","title":"What Extensions Can Do","text":"

Here are some examples of what you can achieve with the Extension API:

  • Add custom components & views in the UI - Extending the Lens Workbench

For an overview of the Lens Extension API, refer to the Common Capabilities page. Extension Guides Overview also includes a list of code samples and guides that illustrate various ways of using the Lens Extension API.

"},{"location":"#how-to-build-extensions","title":"How to Build Extensions","text":"

Here is what each section of the Lens Extension API docs can help you with:

  • Getting Started teaches fundamental concepts for building extensions with the Hello World sample.
  • Extension Capabilities dissects Lens's Extension API into smaller categories and points you to more detailed topics.
  • Extension Guides includes guides and code samples that explain specific usages of Lens Extension API.
  • Testing and Publishing includes in-depth guides on various extension development topics, such as testing and publishing extensions.
  • API Reference contains exhaustive references for the Lens Extension API, Contribution Points, and many other topics.
"},{"location":"#whats-new","title":"What's New","text":"

Just like Lens itself, the extension API updates on a monthly cadence, rolling out new features with every release.

Keep up with Lens and the Lens Extension API by reviewing the release notes.

"},{"location":"#important-changes-since-lens-v4","title":"Important changes since Lens v4","text":"

Lens has undergone major design improvements in v5, which have resulted in several large changes to the extension API. Workspaces are gone, and the catalog is introduced for containing clusters, as well as other items, including custom entities. Lens has migrated from using mobx 5 to mobx 6 for internal state management, and this may have ramifications for extension implementations. Although the API retains many components from v4, given these changes, extensions written for Lens v4 are not compatible with the Lens v5 extension API. See the Lens v4 to v5 extension migration notes on getting old extensions working in Lens v5.

"},{"location":"#looking-for-help","title":"Looking for Help","text":"

If you have questions for extension development, try asking on the Lens Forums. It's a public chatroom for Lens developers, where Lens team members chime in from time to time.

To provide feedback on the documentation or issues with the Lens Extension API, create new issues at lensapp/lens. Please use the labels area/documentation and/or area/extension.

"},{"location":"#downloading-lens","title":"Downloading Lens","text":"

Download Lens for macOS, Windows, or Linux.

"},{"location":"architecture/decisions/","title":"Architecture Decision Records","text":""},{"location":"extensions/extension-migration/","title":"Lens v4 to v5 Extension Migration Notes","text":"
  • Lens v5 inspects the version of the extension to ensure it is compatible. The package.json for your extension must have an \"engines\" field specifying the lens version that your extension is targeted for, e.g:
        \"engines\": {\n        \"lens\": \"^5.0.0-beta.7\"\n    },\n
    Note that Lens v5 supports all the range semantics that semver provides.
  • Types and components have been reorganized, many have been grouped by process (Main and Renderer) plus those not specific to a process (Common). For example the LensMainExtension class is now referred to by Main.LensExtension. See the API Reference for the new organization.
  • The globalPageMenus field of the Renderer extension class (now Renderer.LensExtension) is removed. Global pages can still be made accessible via the application menus and the status bar, as well as from the newly added Welcome menu.
  • The clusterFeatures field of the Renderer extension class (now Renderer.LensExtension) is removed. Cluster features can still be implemented but Lens no longer dictates how a feature's lifecycle (install/upgrade/uninstall) is managed. Renderer.K8sApi.ResourceStack provides the functionality to input and apply kubernetes resources to a cluster. It is up to the extension developer to manage the lifecycle. It could be applied automatically to a cluster by the extension or the end-user could be expected to install it, etc. from the cluster Settings page.
  • Lens v5 now relies on mobx 6 for state management. Extensions that use mobx will need to be modified to work with mobx 6. See Migrating from Mobx 4/5 for specific details.

For an example of an existing extension that is compatible with Lens v5 see the Lens Resource Map Extension

"},{"location":"extensions/api/","title":"API Reference","text":"

@k8slens/extensions / Exports

"},{"location":"extensions/api/#extension-api-reference","title":"Extension API Reference","text":""},{"location":"extensions/api/#apis","title":"APIs","text":"
  • Common
  • Main
  • Renderer
"},{"location":"extensions/api/modules/","title":"Modules","text":"

@k8slens/extensions / Exports

"},{"location":"extensions/api/modules/#k8slensextensions","title":"@k8slens/extensions","text":""},{"location":"extensions/api/modules/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/#namespaces","title":"Namespaces","text":"
  • Common
  • Main
  • Renderer
"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/","title":"Common.Catalog.CatalogCategory","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogCategory

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#class-catalogcategory","title":"Class: CatalogCategory","text":"

Common.Catalog.CatalogCategory

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#hierarchy","title":"Hierarchy","text":"
  • CatalogCategory_base

\u21b3 CatalogCategory

\u21b3\u21b3 KubernetesClusterCategory

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#properties","title":"Properties","text":"
  • apiVersion
  • filters
  • kind
  • metadata
  • spec
"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#methods","title":"Methods","text":"
  • addMenuFilter
  • filteredItems
  • getBadge
  • getId
  • getName
  • parseId
"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#constructor","title":"constructor","text":"

\u2022 new CatalogCategory()

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#inherited-from","title":"Inherited from","text":"

CatalogCategory_base.constructor

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#apiversion","title":"apiVersion","text":"

\u2022 Readonly Abstract apiVersion: string

The version of category that you are wanting to declare.

Currently supported values:

  • \"catalog.k8slens.dev/v1alpha1\"
"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#filters","title":"filters","text":"

\u2022 Protected Readonly filters: ObservableSet<AddMenuFilter>

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#kind","title":"kind","text":"

\u2022 Readonly Abstract kind: string

The kind of item you wish to declare.

Currently supported values:

  • \"CatalogCategory\"
"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#metadata","title":"metadata","text":"

\u2022 Readonly Abstract metadata: CatalogCategoryMetadata

The data about the category itself

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#spec","title":"spec","text":"

\u2022 Readonly Abstract spec: CatalogCategorySpec

The most important part of a category, as it is where entity versions are declared.

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#addmenufilter","title":"addMenuFilter","text":"

\u25b8 addMenuFilter(fn): Disposer

Add a filter for menu items of catalogAddMenu

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#parameters","title":"Parameters","text":"Name Type Description fn AddMenuFilter The function that should return a truthy value if that menu item should be displayed"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#returns","title":"Returns","text":"

Disposer

A function to remove that filter

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#filtereditems","title":"filteredItems","text":"

\u25b8 filteredItems(menuItems): CatalogEntityAddMenu[]

Filter menuItems according to the Category's set filters

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#parameters_1","title":"Parameters","text":"Name Type Description menuItems CatalogEntityAddMenu[] menu items to filter"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#returns_1","title":"Returns","text":"

CatalogEntityAddMenu[]

filtered menu items

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#getbadge","title":"getBadge","text":"

\u25b8 getBadge(): ReactNode

Get the badge of this category. Defaults to no badge. The badge is displayed next to the Category name in the Catalog Category menu

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#returns_2","title":"Returns","text":"

ReactNode

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#getid","title":"getId","text":"

\u25b8 getId(): string

Get the ID of this category

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#returns_3","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#getname","title":"getName","text":"

\u25b8 getName(): string

Get the name of this category

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#returns_4","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#parseid","title":"parseId","text":"

\u25b8 Static parseId(id): Object

Parse a category ID into parts.

"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#parameters_2","title":"Parameters","text":"Name Type Description id string The id of a category is parse"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#returns_5","title":"Returns","text":"

Object

The group and kind parts of the ID

Name Type group? string kind? string"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/","title":"Common.Catalog.CatalogEntity","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogEntity

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#class-catalogentitymetadata-status-spec","title":"Class: CatalogEntity<Metadata, Status, Spec>","text":"

Common.Catalog.CatalogEntity

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends CatalogEntityMetadata = CatalogEntityMetadata Status extends CatalogEntityStatus = CatalogEntityStatus Spec extends CatalogEntitySpec = CatalogEntitySpec"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#hierarchy","title":"Hierarchy","text":"
  • CatalogEntity

\u21b3 KubernetesCluster

\u21b3 GeneralEntity

\u21b3 WebLink

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#implements","title":"Implements","text":"
  • CatalogEntityKindData
"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#methods","title":"Methods","text":"
  • getId
  • getName
  • getSource
  • isEnabled
  • onContextMenuOpen
  • onRun
  • onSettingsOpen
"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#constructor","title":"constructor","text":"

\u2022 new CatalogEntity<Metadata, Status, Spec>(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#type-parameters_1","title":"Type parameters","text":"Name Type Metadata extends CatalogEntityMetadata<Metadata> = CatalogEntityMetadata Status extends CatalogEntityStatus = CatalogEntityStatus Spec extends CatalogEntitySpec = CatalogEntitySpec"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb CatalogEntityData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#apiversion","title":"apiVersion","text":"

\u2022 Readonly Abstract apiVersion: string

The group and version of this class.

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#implementation-of","title":"Implementation of","text":"

CatalogEntityKindData.apiVersion

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#kind","title":"kind","text":"

\u2022 Readonly Abstract kind: string

A DNS label name of the entity.

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#implementation-of_1","title":"Implementation of","text":"

CatalogEntityKindData.kind

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#metadata","title":"metadata","text":"

\u2022 metadata: Metadata

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#spec","title":"spec","text":"

\u2022 spec: Spec

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#status","title":"status","text":"

\u2022 status: Status

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#getid","title":"getId","text":"

\u25b8 getId(): string

Get the UID of this entity

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#getname","title":"getName","text":"

\u25b8 getName(): string

Get the name of this entity

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#returns_1","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#getsource","title":"getSource","text":"

\u25b8 getSource(): string

Get the specified source of this entity, defaulting to \"unknown\" if not provided

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#returns_2","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#isenabled","title":"isEnabled","text":"

\u25b8 isEnabled(): boolean

Get if this entity is enabled.

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#returns_3","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#oncontextmenuopen","title":"onContextMenuOpen","text":"

\u25b8 Optional onContextMenuOpen(context): void | Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#parameters_1","title":"Parameters","text":"Name Type context CatalogEntityContextMenuContext"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#returns_4","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#onrun","title":"onRun","text":"

\u25b8 Optional onRun(context): void | Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#parameters_2","title":"Parameters","text":"Name Type context CatalogEntityActionContext"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#returns_5","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#onsettingsopen","title":"onSettingsOpen","text":"

\u25b8 Optional onSettingsOpen(context): void | Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#parameters_3","title":"Parameters","text":"Name Type context CatalogEntitySettingsContext"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#returns_6","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/","title":"Common.Catalog.GeneralEntity","text":"

@k8slens/extensions / Exports / Common / Catalog / GeneralEntity

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#class-generalentity","title":"Class: GeneralEntity","text":"

Common.Catalog.GeneralEntity

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#hierarchy","title":"Hierarchy","text":"
  • CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, GeneralEntitySpec>

\u21b3 GeneralEntity

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#methods","title":"Methods","text":"
  • getId
  • getName
  • getSource
  • isEnabled
  • onContextMenuOpen
  • onRun
  • onSettingsOpen
"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#constructor","title":"constructor","text":"

\u2022 new GeneralEntity(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb CatalogEntityData<CatalogEntityMetadata, CatalogEntityStatus, GeneralEntitySpec>"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#inherited-from","title":"Inherited from","text":"

CatalogEntity.constructor

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#apiversion","title":"apiVersion","text":"

\u2022 Readonly apiVersion: \"entity.k8slens.dev/v1alpha1\"

The group and version of this class.

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#overrides","title":"Overrides","text":"

CatalogEntity.apiVersion

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#kind","title":"kind","text":"

\u2022 Readonly kind: \"General\"

A DNS label name of the entity.

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#overrides_1","title":"Overrides","text":"

CatalogEntity.kind

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#metadata","title":"metadata","text":"

\u2022 metadata: CatalogEntityMetadata

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#inherited-from_1","title":"Inherited from","text":"

CatalogEntity.metadata

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#spec","title":"spec","text":"

\u2022 spec: GeneralEntitySpec

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#inherited-from_2","title":"Inherited from","text":"

CatalogEntity.spec

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#status","title":"status","text":"

\u2022 status: CatalogEntityStatus

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#inherited-from_3","title":"Inherited from","text":"

CatalogEntity.status

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#getid","title":"getId","text":"

\u25b8 getId(): string

Get the UID of this entity

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#inherited-from_4","title":"Inherited from","text":"

CatalogEntity.getId

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#getname","title":"getName","text":"

\u25b8 getName(): string

Get the name of this entity

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#returns_1","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#inherited-from_5","title":"Inherited from","text":"

CatalogEntity.getName

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#getsource","title":"getSource","text":"

\u25b8 getSource(): string

Get the specified source of this entity, defaulting to \"unknown\" if not provided

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#returns_2","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#inherited-from_6","title":"Inherited from","text":"

CatalogEntity.getSource

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#isenabled","title":"isEnabled","text":"

\u25b8 isEnabled(): boolean

Get if this entity is enabled.

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#returns_3","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#inherited-from_7","title":"Inherited from","text":"

CatalogEntity.isEnabled

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#oncontextmenuopen","title":"onContextMenuOpen","text":"

\u25b8 Optional onContextMenuOpen(context): void | Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#parameters_1","title":"Parameters","text":"Name Type context CatalogEntityContextMenuContext"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#returns_4","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#inherited-from_8","title":"Inherited from","text":"

CatalogEntity.onContextMenuOpen

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#onrun","title":"onRun","text":"

\u25b8 onRun(context): Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#parameters_2","title":"Parameters","text":"Name Type context CatalogEntityActionContext"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#returns_5","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#overrides_2","title":"Overrides","text":"

CatalogEntity.onRun

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#onsettingsopen","title":"onSettingsOpen","text":"

\u25b8 Optional onSettingsOpen(context): void | Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#parameters_3","title":"Parameters","text":"Name Type context CatalogEntitySettingsContext"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#returns_6","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#inherited-from_9","title":"Inherited from","text":"

CatalogEntity.onSettingsOpen

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/","title":"Common.Catalog.KubernetesCluster","text":"

@k8slens/extensions / Exports / Common / Catalog / KubernetesCluster

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#class-kubernetesclustermetadata-status-spec","title":"Class: KubernetesCluster<Metadata, Status, Spec>","text":"

Common.Catalog.KubernetesCluster

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubernetesClusterMetadata = KubernetesClusterMetadata Status extends KubernetesClusterStatus = KubernetesClusterStatus Spec extends KubernetesClusterSpec = KubernetesClusterSpec"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#hierarchy","title":"Hierarchy","text":"
  • CatalogEntity<Metadata, Status, Spec>

\u21b3 KubernetesCluster

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiVersion
  • kind
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#methods","title":"Methods","text":"
  • connect
  • disconnect
  • getId
  • getName
  • getSource
  • isEnabled
  • onContextMenuOpen
  • onDetailsOpen
  • onRun
  • onSettingsOpen
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#constructor","title":"constructor","text":"

\u2022 new KubernetesCluster<Metadata, Status, Spec>(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#type-parameters_1","title":"Type parameters","text":"Name Type Metadata extends KubernetesClusterMetadata<Metadata> = KubernetesClusterMetadata Status extends KubernetesClusterStatus = KubernetesClusterStatus Spec extends KubernetesClusterSpec<Spec> = KubernetesClusterSpec"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb CatalogEntityData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#inherited-from","title":"Inherited from","text":"

CatalogEntity.constructor

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#apiversion","title":"apiVersion","text":"

\u2022 Readonly apiVersion: string

The group and version of this class.

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#overrides","title":"Overrides","text":"

CatalogEntity.apiVersion

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#kind","title":"kind","text":"

\u2022 Readonly kind: string

A DNS label name of the entity.

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#overrides_1","title":"Overrides","text":"

CatalogEntity.kind

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#metadata","title":"metadata","text":"

\u2022 metadata: Metadata

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#inherited-from_1","title":"Inherited from","text":"

CatalogEntity.metadata

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#spec","title":"spec","text":"

\u2022 spec: Spec

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#inherited-from_2","title":"Inherited from","text":"

CatalogEntity.spec

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#status","title":"status","text":"

\u2022 status: Status

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#inherited-from_3","title":"Inherited from","text":"

CatalogEntity.status

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#apiversion_1","title":"apiVersion","text":"

\u25aa Static Readonly apiVersion: string

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: string

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#connect","title":"connect","text":"

\u25b8 connect(): Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#returns","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#disconnect","title":"disconnect","text":"

\u25b8 disconnect(): Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#returns_1","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#getid","title":"getId","text":"

\u25b8 getId(): string

Get the UID of this entity

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#returns_2","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#inherited-from_4","title":"Inherited from","text":"

CatalogEntity.getId

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#getname","title":"getName","text":"

\u25b8 getName(): string

Get the name of this entity

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#returns_3","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#inherited-from_5","title":"Inherited from","text":"

CatalogEntity.getName

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#getsource","title":"getSource","text":"

\u25b8 getSource(): string

Get the specified source of this entity, defaulting to \"unknown\" if not provided

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#returns_4","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#inherited-from_6","title":"Inherited from","text":"

CatalogEntity.getSource

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#isenabled","title":"isEnabled","text":"

\u25b8 isEnabled(): boolean

Get if this entity is enabled.

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#inherited-from_7","title":"Inherited from","text":"

CatalogEntity.isEnabled

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#oncontextmenuopen","title":"onContextMenuOpen","text":"

\u25b8 onContextMenuOpen(context): void

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#parameters_1","title":"Parameters","text":"Name Type context CatalogEntityContextMenuContext"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#returns_6","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#overrides_2","title":"Overrides","text":"

CatalogEntity.onContextMenuOpen

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#ondetailsopen","title":"onDetailsOpen","text":"

\u25b8 onDetailsOpen(): void

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#returns_7","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#onrun","title":"onRun","text":"

\u25b8 onRun(context): Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#parameters_2","title":"Parameters","text":"Name Type context CatalogEntityActionContext"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#returns_8","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#overrides_3","title":"Overrides","text":"

CatalogEntity.onRun

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#onsettingsopen","title":"onSettingsOpen","text":"

\u25b8 onSettingsOpen(): void

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#returns_9","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#overrides_4","title":"Overrides","text":"

CatalogEntity.onSettingsOpen

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/","title":"Common.Catalog.KubernetesClusterCategory","text":"

@k8slens/extensions / Exports / Common / Catalog / KubernetesClusterCategory

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#class-kubernetesclustercategory","title":"Class: KubernetesClusterCategory","text":"

Common.Catalog.KubernetesClusterCategory

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#hierarchy","title":"Hierarchy","text":"
  • CatalogCategory

\u21b3 KubernetesClusterCategory

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#properties","title":"Properties","text":"
  • apiVersion
  • filters
  • kind
  • metadata
  • spec
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#methods","title":"Methods","text":"
  • addMenuFilter
  • filteredItems
  • getBadge
  • getId
  • getName
  • parseId
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#constructor","title":"constructor","text":"

\u2022 new KubernetesClusterCategory()

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#inherited-from","title":"Inherited from","text":"

CatalogCategory.constructor

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#apiversion","title":"apiVersion","text":"

\u2022 Readonly apiVersion: \"catalog.k8slens.dev/v1alpha1\"

The version of category that you are wanting to declare.

Currently supported values:

  • \"catalog.k8slens.dev/v1alpha1\"
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#overrides","title":"Overrides","text":"

CatalogCategory.apiVersion

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#filters","title":"filters","text":"

\u2022 Protected Readonly filters: ObservableSet<AddMenuFilter>

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#inherited-from_1","title":"Inherited from","text":"

CatalogCategory.filters

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#kind","title":"kind","text":"

\u2022 Readonly kind: \"CatalogCategory\"

The kind of item you wish to declare.

Currently supported values:

  • \"CatalogCategory\"
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#overrides_1","title":"Overrides","text":"

CatalogCategory.kind

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#metadata","title":"metadata","text":"

\u2022 metadata: Object

The data about the category itself

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#type-declaration","title":"Type declaration","text":"Name Type icon string name string"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#overrides_2","title":"Overrides","text":"

CatalogCategory.metadata

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#spec","title":"spec","text":"

\u2022 spec: CatalogCategorySpec

The most important part of a category, as it is where entity versions are declared.

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#overrides_3","title":"Overrides","text":"

CatalogCategory.spec

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#addmenufilter","title":"addMenuFilter","text":"

\u25b8 addMenuFilter(fn): Disposer

Add a filter for menu items of catalogAddMenu

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#parameters","title":"Parameters","text":"Name Type Description fn AddMenuFilter The function that should return a truthy value if that menu item should be displayed"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#returns","title":"Returns","text":"

Disposer

A function to remove that filter

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#inherited-from_2","title":"Inherited from","text":"

CatalogCategory.addMenuFilter

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#filtereditems","title":"filteredItems","text":"

\u25b8 filteredItems(menuItems): CatalogEntityAddMenu[]

Filter menuItems according to the Category's set filters

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#parameters_1","title":"Parameters","text":"Name Type Description menuItems CatalogEntityAddMenu[] menu items to filter"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#returns_1","title":"Returns","text":"

CatalogEntityAddMenu[]

filtered menu items

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#inherited-from_3","title":"Inherited from","text":"

CatalogCategory.filteredItems

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#getbadge","title":"getBadge","text":"

\u25b8 getBadge(): ReactNode

Get the badge of this category. Defaults to no badge. The badge is displayed next to the Category name in the Catalog Category menu

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#returns_2","title":"Returns","text":"

ReactNode

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#inherited-from_4","title":"Inherited from","text":"

CatalogCategory.getBadge

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#getid","title":"getId","text":"

\u25b8 getId(): string

Get the ID of this category

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#returns_3","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#inherited-from_5","title":"Inherited from","text":"

CatalogCategory.getId

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#getname","title":"getName","text":"

\u25b8 getName(): string

Get the name of this category

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#returns_4","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#inherited-from_6","title":"Inherited from","text":"

CatalogCategory.getName

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#parseid","title":"parseId","text":"

\u25b8 Static parseId(id): Object

Parse a category ID into parts.

"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#parameters_2","title":"Parameters","text":"Name Type Description id string The id of a category is parse"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#returns_5","title":"Returns","text":"

Object

The group and kind parts of the ID

Name Type group? string kind? string"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#inherited-from_7","title":"Inherited from","text":"

CatalogCategory.parseId

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/","title":"Common.Catalog.WebLink","text":"

@k8slens/extensions / Exports / Common / Catalog / WebLink

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#class-weblink","title":"Class: WebLink","text":"

Common.Catalog.WebLink

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#hierarchy","title":"Hierarchy","text":"
  • CatalogEntity<CatalogEntityMetadata, WebLinkStatus, WebLinkSpec>

\u21b3 WebLink

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Common.Catalog.WebLink/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiVersion
  • kind
"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#methods","title":"Methods","text":"
  • getId
  • getName
  • getSource
  • isEnabled
  • onContextMenuOpen
  • onRun
  • onSettingsOpen
"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Common.Catalog.WebLink/#constructor","title":"constructor","text":"

\u2022 new WebLink(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb CatalogEntityData<CatalogEntityMetadata, WebLinkStatus, WebLinkSpec>"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#inherited-from","title":"Inherited from","text":"

CatalogEntity.constructor

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Common.Catalog.WebLink/#apiversion","title":"apiVersion","text":"

\u2022 Readonly apiVersion: \"entity.k8slens.dev/v1alpha1\"

The group and version of this class.

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#overrides","title":"Overrides","text":"

CatalogEntity.apiVersion

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#kind","title":"kind","text":"

\u2022 Readonly kind: \"WebLink\"

A DNS label name of the entity.

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#overrides_1","title":"Overrides","text":"

CatalogEntity.kind

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#metadata","title":"metadata","text":"

\u2022 metadata: CatalogEntityMetadata

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#inherited-from_1","title":"Inherited from","text":"

CatalogEntity.metadata

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#spec","title":"spec","text":"

\u2022 spec: WebLinkSpec

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#inherited-from_2","title":"Inherited from","text":"

CatalogEntity.spec

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#status","title":"status","text":"

\u2022 status: WebLinkStatus

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#inherited-from_3","title":"Inherited from","text":"

CatalogEntity.status

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#apiversion_1","title":"apiVersion","text":"

\u25aa Static Readonly apiVersion: \"entity.k8slens.dev/v1alpha1\"

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"WebLink\"

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Common.Catalog.WebLink/#getid","title":"getId","text":"

\u25b8 getId(): string

Get the UID of this entity

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#inherited-from_4","title":"Inherited from","text":"

CatalogEntity.getId

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#getname","title":"getName","text":"

\u25b8 getName(): string

Get the name of this entity

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#returns_1","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#inherited-from_5","title":"Inherited from","text":"

CatalogEntity.getName

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#getsource","title":"getSource","text":"

\u25b8 getSource(): string

Get the specified source of this entity, defaulting to \"unknown\" if not provided

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#returns_2","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#inherited-from_6","title":"Inherited from","text":"

CatalogEntity.getSource

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#isenabled","title":"isEnabled","text":"

\u25b8 isEnabled(): boolean

Get if this entity is enabled.

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#returns_3","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#inherited-from_7","title":"Inherited from","text":"

CatalogEntity.isEnabled

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#oncontextmenuopen","title":"onContextMenuOpen","text":"

\u25b8 onContextMenuOpen(context): void

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#parameters_1","title":"Parameters","text":"Name Type context CatalogEntityContextMenuContext"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#returns_4","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#overrides_2","title":"Overrides","text":"

CatalogEntity.onContextMenuOpen

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#onrun","title":"onRun","text":"

\u25b8 onRun(): Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#returns_5","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#overrides_3","title":"Overrides","text":"

CatalogEntity.onRun

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#onsettingsopen","title":"onSettingsOpen","text":"

\u25b8 Optional onSettingsOpen(context): void | Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#parameters_2","title":"Parameters","text":"Name Type context CatalogEntitySettingsContext"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#returns_6","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#inherited-from_8","title":"Inherited from","text":"

CatalogEntity.onSettingsOpen

"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/","title":"Common.EventBus.EventEmitter","text":"

@k8slens/extensions / Exports / Common / EventBus / EventEmitter

"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#class-eventemitterd","title":"Class: EventEmitter<D>","text":"

Common.EventBus.EventEmitter

"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#type-parameters","title":"Type parameters","text":"Name Type D extends any[]"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#properties","title":"Properties","text":"
  • listeners
"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#methods","title":"Methods","text":"
  • addListener
  • emit
  • removeAllListeners
  • removeListener
"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#constructor","title":"constructor","text":"

\u2022 new EventEmitter<D>()

"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#type-parameters_1","title":"Type parameters","text":"Name Type D extends any[]"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#listeners","title":"listeners","text":"

\u2022 Protected listeners: [EventEmitterCallback<D>, EventEmitterOptions][]

"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#addlistener","title":"addListener","text":"

\u25b8 addListener(callback, options?): void

"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#parameters","title":"Parameters","text":"Name Type callback EventEmitterCallback<D> options? EventEmitterOptions"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#emit","title":"emit","text":"

\u25b8 emit(...data): void

"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#parameters_1","title":"Parameters","text":"Name Type ...data D"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#removealllisteners","title":"removeAllListeners","text":"

\u25b8 removeAllListeners(): void

"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#removelistener","title":"removeListener","text":"

\u25b8 removeListener(callback): void

"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#parameters_2","title":"Parameters","text":"Name Type callback EventEmitterCallback<D>"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Common.LensExtension/","title":"Common.LensExtension","text":"

@k8slens/extensions / Exports / Common / LensExtension

"},{"location":"extensions/api/classes/Common.LensExtension/#class-lensextension","title":"Class: LensExtension","text":"

Common.LensExtension

"},{"location":"extensions/api/classes/Common.LensExtension/#hierarchy","title":"Hierarchy","text":"
  • LensExtension

\u21b3 LensExtension

\u21b3 LensExtension

"},{"location":"extensions/api/classes/Common.LensExtension/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Common.LensExtension/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Common.LensExtension/#properties","title":"Properties","text":"
  • id
  • isBundled
  • manifest
  • manifestPath
  • protocolHandlers
"},{"location":"extensions/api/classes/Common.LensExtension/#accessors","title":"Accessors","text":"
  • description
  • isEnabled
  • name
  • sanitizedExtensionId
  • storeName
  • version
"},{"location":"extensions/api/classes/Common.LensExtension/#methods","title":"Methods","text":"
  • activate
  • disable
  • enable
  • getExtensionFileFolder
  • onActivate
  • onDeactivate
"},{"location":"extensions/api/classes/Common.LensExtension/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Common.LensExtension/#constructor","title":"constructor","text":"

\u2022 new LensExtension(deps, \u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Common.LensExtension/#parameters","title":"Parameters","text":"Name Type deps LensExtensionDependencies \u00abdestructured\u00bb InstalledExtension"},{"location":"extensions/api/classes/Common.LensExtension/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Common.LensExtension/#id","title":"id","text":"

\u2022 Readonly id: string

"},{"location":"extensions/api/classes/Common.LensExtension/#isbundled","title":"isBundled","text":"

\u2022 Readonly isBundled: boolean

"},{"location":"extensions/api/classes/Common.LensExtension/#manifest","title":"manifest","text":"

\u2022 Readonly manifest: LensExtensionManifest

"},{"location":"extensions/api/classes/Common.LensExtension/#manifestpath","title":"manifestPath","text":"

\u2022 Readonly manifestPath: string

"},{"location":"extensions/api/classes/Common.LensExtension/#protocolhandlers","title":"protocolHandlers","text":"

\u2022 protocolHandlers: ProtocolHandlerRegistration[]

"},{"location":"extensions/api/classes/Common.LensExtension/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Common.LensExtension/#description","title":"description","text":"

\u2022 get description(): undefined | string

"},{"location":"extensions/api/classes/Common.LensExtension/#returns","title":"Returns","text":"

undefined | string

"},{"location":"extensions/api/classes/Common.LensExtension/#isenabled","title":"isEnabled","text":"

\u2022 get isEnabled(): boolean

"},{"location":"extensions/api/classes/Common.LensExtension/#returns_1","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Common.LensExtension/#name","title":"name","text":"

\u2022 get name(): string

"},{"location":"extensions/api/classes/Common.LensExtension/#returns_2","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.LensExtension/#sanitizedextensionid","title":"sanitizedExtensionId","text":"

\u2022 get sanitizedExtensionId(): string

"},{"location":"extensions/api/classes/Common.LensExtension/#returns_3","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.LensExtension/#storename","title":"storeName","text":"

\u2022 get storeName(): string

"},{"location":"extensions/api/classes/Common.LensExtension/#returns_4","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.LensExtension/#version","title":"version","text":"

\u2022 get version(): string

"},{"location":"extensions/api/classes/Common.LensExtension/#returns_5","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.LensExtension/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Common.LensExtension/#activate","title":"activate","text":"

\u25b8 activate(): Promise<void>

"},{"location":"extensions/api/classes/Common.LensExtension/#returns_6","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Common.LensExtension/#disable","title":"disable","text":"

\u25b8 disable(): Promise<void>

"},{"location":"extensions/api/classes/Common.LensExtension/#returns_7","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Common.LensExtension/#enable","title":"enable","text":"

\u25b8 enable(): Promise<void>

"},{"location":"extensions/api/classes/Common.LensExtension/#returns_8","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Common.LensExtension/#getextensionfilefolder","title":"getExtensionFileFolder","text":"

\u25b8 getExtensionFileFolder(): Promise<string>

getExtensionFileFolder returns the path to an already created folder. This folder is for the sole use of this extension.

Note: there is no security done on this folder, only obfuscation of the folder name.

"},{"location":"extensions/api/classes/Common.LensExtension/#returns_9","title":"Returns","text":"

Promise<string>

"},{"location":"extensions/api/classes/Common.LensExtension/#onactivate","title":"onActivate","text":"

\u25b8 Protected onActivate(): void | Promise<void>

"},{"location":"extensions/api/classes/Common.LensExtension/#returns_10","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/classes/Common.LensExtension/#ondeactivate","title":"onDeactivate","text":"

\u25b8 Protected onDeactivate(): void | Promise<void>

"},{"location":"extensions/api/classes/Common.LensExtension/#returns_11","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/","title":"Common.Store.ExtensionStore","text":"

@k8slens/extensions / Exports / Common / Store / ExtensionStore

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#class-extensionstoret","title":"Class: ExtensionStore<T>","text":"

Common.Store.ExtensionStore

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#type-parameters","title":"Type parameters","text":"Name Type T extends object"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#properties","title":"Properties","text":"
  • extension
  • persistentStorage
  • rawParams
"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#methods","title":"Methods","text":"
  • cwd
  • fromStore
  • load
  • loadExtension
  • toJSON
  • createInstance
  • getInstance
  • resetInstance
"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#constructor","title":"constructor","text":"

\u2022 new ExtensionStore<T>(rawParams)

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#type-parameters_1","title":"Type parameters","text":"Name Type T extends object"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#parameters","title":"Parameters","text":"Name Type rawParams ExtensionStoreParams<T>"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#extension","title":"extension","text":"

\u2022 Protected Optional extension: LensExtension

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#persistentstorage","title":"persistentStorage","text":"

\u2022 Protected Optional persistentStorage: PersistentStorage

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#rawparams","title":"rawParams","text":"

\u2022 Protected Readonly rawParams: ExtensionStoreParams<T>

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#cwd","title":"cwd","text":"

\u25b8 Protected cwd(): string

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#fromstore","title":"fromStore","text":"

\u25b8 Abstract fromStore(data): void

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#parameters_1","title":"Parameters","text":"Name Type data Partial<T>"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#load","title":"load","text":"

\u25b8 load(): void

Deprecated

Never use this method. Instead call loadExtension

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#loadextension","title":"loadExtension","text":"

\u25b8 loadExtension(extension): void

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#parameters_2","title":"Parameters","text":"Name Type extension LensExtension"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#tojson","title":"toJSON","text":"

\u25b8 Abstract toJSON(): T

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#returns_4","title":"Returns","text":"

T

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#createinstance","title":"createInstance","text":"

\u25b8 Static createInstance<T, R>(this, ...args): T

Deprecated

This is a form of global shared state. Just call new Store(...)

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#type-parameters_2","title":"Type parameters","text":"Name Type T T R extends any[]"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#parameters_3","title":"Parameters","text":"Name Type this StaticThis<T, R> ...args R"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#returns_5","title":"Returns","text":"

T

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#getinstance","title":"getInstance","text":"

\u25b8 Static getInstance<T, R>(this, strict?): T

Deprecated

This is a form of global shared state. Just call new Store(...)

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#type-parameters_3","title":"Type parameters","text":"Name Type T T R extends any[]"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#parameters_4","title":"Parameters","text":"Name Type this StaticThis<T, R> strict? true"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#returns_6","title":"Returns","text":"

T

\u25b8 Static getInstance<T, R>(this, strict): undefined | T

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#type-parameters_4","title":"Type parameters","text":"Name Type T T R extends any[]"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#parameters_5","title":"Parameters","text":"Name Type this StaticThis<T, R> strict false"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#returns_7","title":"Returns","text":"

undefined | T

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#resetinstance","title":"resetInstance","text":"

\u25b8 Static resetInstance(): void

Deprecated

This is a form of global shared state. Just call new Store(...)

"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#returns_8","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Common.Util.Singleton/","title":"Common.Util.Singleton","text":"

@k8slens/extensions / Exports / Common / Util / Singleton

"},{"location":"extensions/api/classes/Common.Util.Singleton/#class-singleton","title":"Class: Singleton","text":"

Common.Util.Singleton

Deprecated

This is a form of global shared state

"},{"location":"extensions/api/classes/Common.Util.Singleton/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Common.Util.Singleton/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Common.Util.Singleton/#methods","title":"Methods","text":"
  • createInstance
  • getInstance
  • resetInstance
"},{"location":"extensions/api/classes/Common.Util.Singleton/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Common.Util.Singleton/#constructor","title":"constructor","text":"

\u2022 new Singleton()

"},{"location":"extensions/api/classes/Common.Util.Singleton/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Common.Util.Singleton/#createinstance","title":"createInstance","text":"

\u25b8 Static createInstance<T, R>(this, ...args): T

Creates the single instance of the child class if one was not already created.

Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls.

Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used.

"},{"location":"extensions/api/classes/Common.Util.Singleton/#type-parameters","title":"Type parameters","text":"Name Type T extends Singleton<T> R extends any[]"},{"location":"extensions/api/classes/Common.Util.Singleton/#parameters","title":"Parameters","text":"Name Type Description this StaticThis<T, R> Implicit argument that is the child class type ...args R The constructor arguments for the child class"},{"location":"extensions/api/classes/Common.Util.Singleton/#returns","title":"Returns","text":"

T

An instance of the child class

"},{"location":"extensions/api/classes/Common.Util.Singleton/#getinstance","title":"getInstance","text":"

\u25b8 Static getInstance<T, R>(this, strict?): T

Get the instance of the child class that was previously created.

"},{"location":"extensions/api/classes/Common.Util.Singleton/#type-parameters_1","title":"Type parameters","text":"Name Type T T R extends any[]"},{"location":"extensions/api/classes/Common.Util.Singleton/#parameters_1","title":"Parameters","text":"Name Type Description this StaticThis<T, R> Implicit argument that is the child class type strict? true If false will return undefined instead of throwing when an instance doesn't exist. Default: true"},{"location":"extensions/api/classes/Common.Util.Singleton/#returns_1","title":"Returns","text":"

T

An instance of the child class

\u25b8 Static getInstance<T, R>(this, strict): undefined | T

"},{"location":"extensions/api/classes/Common.Util.Singleton/#type-parameters_2","title":"Type parameters","text":"Name Type T T R extends any[]"},{"location":"extensions/api/classes/Common.Util.Singleton/#parameters_2","title":"Parameters","text":"Name Type this StaticThis<T, R> strict false"},{"location":"extensions/api/classes/Common.Util.Singleton/#returns_2","title":"Returns","text":"

undefined | T

"},{"location":"extensions/api/classes/Common.Util.Singleton/#resetinstance","title":"resetInstance","text":"

\u25b8 Static resetInstance(): void

Delete the instance of the child class.

Note: this doesn't prevent callers of getInstance from storing the result in a global.

There is no way in JS or TS to prevent globals like that.

"},{"location":"extensions/api/classes/Common.Util.Singleton/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.Ipc/","title":"Main.Ipc","text":"

@k8slens/extensions / Exports / Main / Ipc

"},{"location":"extensions/api/classes/Main.Ipc/#class-ipc","title":"Class: Ipc","text":"

Main.Ipc

"},{"location":"extensions/api/classes/Main.Ipc/#hierarchy","title":"Hierarchy","text":"
  • IpcRegistrar

\u21b3 Ipc

"},{"location":"extensions/api/classes/Main.Ipc/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.Ipc/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.Ipc/#properties","title":"Properties","text":"
  • [IpcPrefix]
  • extension
"},{"location":"extensions/api/classes/Main.Ipc/#methods","title":"Methods","text":"
  • broadcast
  • handle
  • listen
  • createInstance
  • getInstance
  • resetInstance
"},{"location":"extensions/api/classes/Main.Ipc/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.Ipc/#constructor","title":"constructor","text":"

\u2022 new Ipc(extension)

"},{"location":"extensions/api/classes/Main.Ipc/#parameters","title":"Parameters","text":"Name Type extension LensExtension"},{"location":"extensions/api/classes/Main.Ipc/#overrides","title":"Overrides","text":"

IpcRegistrar.constructor

"},{"location":"extensions/api/classes/Main.Ipc/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.Ipc/#ipcprefix","title":"[IpcPrefix]","text":"

\u2022 Readonly [IpcPrefix]: string

"},{"location":"extensions/api/classes/Main.Ipc/#inherited-from","title":"Inherited from","text":"

IpcRegistrar.[IpcPrefix]

"},{"location":"extensions/api/classes/Main.Ipc/#extension","title":"extension","text":"

\u2022 Protected Readonly extension: LensExtension

"},{"location":"extensions/api/classes/Main.Ipc/#inherited-from_1","title":"Inherited from","text":"

IpcRegistrar.extension

"},{"location":"extensions/api/classes/Main.Ipc/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.Ipc/#broadcast","title":"broadcast","text":"

\u25b8 broadcast(channel, ...args): void

"},{"location":"extensions/api/classes/Main.Ipc/#parameters_1","title":"Parameters","text":"Name Type Description channel string The channel to broadcast to your whole extension, both main and renderer ...args any[] The arguments passed to all listeners"},{"location":"extensions/api/classes/Main.Ipc/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.Ipc/#inherited-from_2","title":"Inherited from","text":"

IpcRegistrar.broadcast

"},{"location":"extensions/api/classes/Main.Ipc/#handle","title":"handle","text":"

\u25b8 handle(channel, handler): void

Declare a RPC over channel. Lens will cleanup when the extension is disabled or uninstalled

"},{"location":"extensions/api/classes/Main.Ipc/#parameters_2","title":"Parameters","text":"Name Type Description channel string The name of the RPC handler (event: IpcMainInvokeEvent, ...args: any[]) => any The remote procedure that is called"},{"location":"extensions/api/classes/Main.Ipc/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.Ipc/#listen","title":"listen","text":"

\u25b8 listen(channel, listener): Disposer

Listen for broadcasts within your extension

"},{"location":"extensions/api/classes/Main.Ipc/#parameters_3","title":"Parameters","text":"Name Type Description channel string The channel to listen for broadcasts on listener (event: IpcRendererEvent, ...args: any[]) => any The function that will be called with the arguments of the broadcast"},{"location":"extensions/api/classes/Main.Ipc/#returns_2","title":"Returns","text":"

Disposer

An optional disposer, Lens will cleanup when the extension is disabled or uninstalled even if this is not called

"},{"location":"extensions/api/classes/Main.Ipc/#createinstance","title":"createInstance","text":"

\u25b8 Static createInstance<T, R>(this, ...args): T

Creates the single instance of the child class if one was not already created.

Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls.

Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used.

"},{"location":"extensions/api/classes/Main.Ipc/#type-parameters","title":"Type parameters","text":"Name Type T extends Singleton<T> R extends any[]"},{"location":"extensions/api/classes/Main.Ipc/#parameters_4","title":"Parameters","text":"Name Type Description this StaticThis<T, R> Implicit argument that is the child class type ...args R The constructor arguments for the child class"},{"location":"extensions/api/classes/Main.Ipc/#returns_3","title":"Returns","text":"

T

An instance of the child class

"},{"location":"extensions/api/classes/Main.Ipc/#inherited-from_3","title":"Inherited from","text":"

IpcRegistrar.createInstance

"},{"location":"extensions/api/classes/Main.Ipc/#getinstance","title":"getInstance","text":"

\u25b8 Static getInstance<T, R>(this, strict?): T

Get the instance of the child class that was previously created.

"},{"location":"extensions/api/classes/Main.Ipc/#type-parameters_1","title":"Type parameters","text":"Name Type T T R extends any[]"},{"location":"extensions/api/classes/Main.Ipc/#parameters_5","title":"Parameters","text":"Name Type Description this StaticThis<T, R> Implicit argument that is the child class type strict? true If false will return undefined instead of throwing when an instance doesn't exist. Default: true"},{"location":"extensions/api/classes/Main.Ipc/#returns_4","title":"Returns","text":"

T

An instance of the child class

"},{"location":"extensions/api/classes/Main.Ipc/#inherited-from_4","title":"Inherited from","text":"

IpcRegistrar.getInstance

\u25b8 Static getInstance<T, R>(this, strict): undefined | T

"},{"location":"extensions/api/classes/Main.Ipc/#type-parameters_2","title":"Type parameters","text":"Name Type T T R extends any[]"},{"location":"extensions/api/classes/Main.Ipc/#parameters_6","title":"Parameters","text":"Name Type this StaticThis<T, R> strict false"},{"location":"extensions/api/classes/Main.Ipc/#returns_5","title":"Returns","text":"

undefined | T

"},{"location":"extensions/api/classes/Main.Ipc/#inherited-from_5","title":"Inherited from","text":"

IpcRegistrar.getInstance

"},{"location":"extensions/api/classes/Main.Ipc/#resetinstance","title":"resetInstance","text":"

\u25b8 Static resetInstance(): void

Delete the instance of the child class.

Note: this doesn't prevent callers of getInstance from storing the result in a global.

There is no way in JS or TS to prevent globals like that.

"},{"location":"extensions/api/classes/Main.Ipc/#returns_6","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.Ipc/#inherited-from_6","title":"Inherited from","text":"

IpcRegistrar.resetInstance

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/","title":"Main.K8sApi.ClusterRole","text":"

@k8slens/extensions / Exports / Main / K8sApi / ClusterRole

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#class-clusterrole","title":"Class: ClusterRole","text":"

Main.K8sApi.ClusterRole

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<ClusterScopedMetadata, void, void>

\u21b3 ClusterRole

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#properties","title":"Properties","text":"
  • aggregationRule
  • apiVersion
  • kind
  • metadata
  • rules
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getRules
  • getScopedName
  • getSearchFields
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#constructor","title":"constructor","text":"

\u2022 new ClusterRole(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb ClusterRoleData"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#overrides","title":"Overrides","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#aggregationrule","title":"aggregationRule","text":"

\u2022 Optional aggregationRule: AggregationRule

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_1","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#metadata","title":"metadata","text":"

\u2022 metadata: ClusterScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_2","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#rules","title":"rules","text":"

\u2022 Optional rules: PolicyRule[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#spec","title":"spec","text":"

\u2022 spec: void

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_3","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#status","title":"status","text":"

\u2022 Optional status: void

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_4","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#apibase","title":"apiBase","text":"

\u25aa Static apiBase: string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#overrides_1","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_5","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_6","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#kind_1","title":"kind","text":"

\u25aa Static kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#overrides_2","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#namespaced","title":"namespaced","text":"

\u25aa Static namespaced: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#overrides_3","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_13","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_14","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_15","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_16","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getns","title":"getNs","text":"

\u25b8 getNs(): undefined

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_18","title":"Returns","text":"

undefined

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_19","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getrules","title":"getRules","text":"

\u25b8 getRules(): PolicyRule[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_21","title":"Returns","text":"

PolicyRule[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): (undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_23","title":"Returns","text":"

(undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_24","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_25","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_29","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_26","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_30","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_14","title":"Parameters","text":"Name Type data Partial<ClusterRole>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_27","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_31","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/","title":"Main.K8sApi.ClusterRoleBinding","text":"

@k8slens/extensions / Exports / Main / K8sApi / ClusterRoleBinding

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#class-clusterrolebinding","title":"Class: ClusterRoleBinding","text":"

Main.K8sApi.ClusterRoleBinding

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<ClusterScopedMetadata, void, void>

\u21b3 ClusterRoleBinding

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • roleRef
  • spec
  • status
  • subjects
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getSubjectNames
  • getSubjects
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#constructor","title":"constructor","text":"

\u2022 new ClusterRoleBinding(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb ClusterRoleBindingData"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#overrides","title":"Overrides","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_1","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#metadata","title":"metadata","text":"

\u2022 metadata: ClusterScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_2","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#roleref","title":"roleRef","text":"

\u2022 roleRef: RoleRef

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#spec","title":"spec","text":"

\u2022 spec: void

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_3","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#status","title":"status","text":"

\u2022 Optional status: void

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_4","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#subjects","title":"subjects","text":"

\u2022 Optional subjects: Subject[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#apibase","title":"apiBase","text":"

\u25aa Static apiBase: string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#overrides_1","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_5","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_6","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#kind_1","title":"kind","text":"

\u25aa Static kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#overrides_2","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#namespaced","title":"namespaced","text":"

\u25aa Static namespaced: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#overrides_3","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_13","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_14","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_15","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_16","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getns","title":"getNs","text":"

\u25b8 getNs(): undefined

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_18","title":"Returns","text":"

undefined

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_19","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_21","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): (undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_22","title":"Returns","text":"

(undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getsubjectnames","title":"getSubjectNames","text":"

\u25b8 getSubjectNames(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getsubjects","title":"getSubjects","text":"

\u25b8 getSubjects(): Subject[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_24","title":"Returns","text":"

Subject[]

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_25","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_26","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_29","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_27","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_30","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_14","title":"Parameters","text":"Name Type data Partial<ClusterRoleBinding>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_28","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_31","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/","title":"Main.K8sApi.ConfigMap","text":"

@k8slens/extensions / Exports / Main / K8sApi / ConfigMap

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#class-configmap","title":"Class: ConfigMap","text":"

Main.K8sApi.ConfigMap

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, void, void>

\u21b3 ConfigMap

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#properties","title":"Properties","text":"
  • apiVersion
  • binaryData
  • data
  • immutable
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getKeys
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#constructor","title":"constructor","text":"

\u2022 new ConfigMap(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb ConfigMapData"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#overrides","title":"Overrides","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#binarydata","title":"binaryData","text":"

\u2022 binaryData: Partial<Record<string, string>>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#data","title":"data","text":"

\u2022 data: Partial<Record<string, string>>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#immutable","title":"immutable","text":"

\u2022 Optional immutable: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_1","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_2","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#spec","title":"spec","text":"

\u2022 spec: void

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_3","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#status","title":"status","text":"

\u2022 Optional status: void

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_4","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#apibase","title":"apiBase","text":"

\u25aa Static apiBase: string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#overrides_1","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_5","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_6","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#kind_1","title":"kind","text":"

\u25aa Static kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#overrides_2","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#namespaced","title":"namespaced","text":"

\u25aa Static namespaced: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#overrides_3","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_13","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_14","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_15","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_16","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getkeys","title":"getKeys","text":"

\u25b8 getKeys(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_17","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_18","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_20","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_21","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_23","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_24","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_25","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_29","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_26","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_30","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_14","title":"Parameters","text":"Name Type data Partial<ConfigMap>"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_27","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_31","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/","title":"Main.K8sApi.CronJob","text":"

@k8slens/extensions / Exports / Main / K8sApi / CronJob

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#class-cronjob","title":"Class: CronJob","text":"

Main.K8sApi.CronJob

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, CronJobStatus, CronJobSpec>

\u21b3 CronJob

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getLabels
  • getLastScheduleTime
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getSchedule
  • getScopedName
  • getSearchFields
  • getSuspendFlag
  • getTimeDiffFromNow
  • isNeverRun
  • isSuspend
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#constructor","title":"constructor","text":"

\u2022 new CronJob(data)

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, CronJobStatus, CronJobSpec>"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#spec","title":"spec","text":"

\u2022 spec: CronJobSpec

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#status","title":"status","text":"

\u2022 Optional status: CronJobStatus

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/apis/batch/v1/cronjobs\"

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"CronJob\"

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getlastscheduletime","title":"getLastScheduleTime","text":"

\u25b8 getLastScheduleTime(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_18","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_20","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_21","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getschedule","title":"getSchedule","text":"

\u25b8 getSchedule(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_24","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getsuspendflag","title":"getSuspendFlag","text":"

\u25b8 getSuspendFlag(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_25","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_26","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#isneverrun","title":"isNeverRun","text":"

\u25b8 isNeverRun(): boolean

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_27","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#issuspend","title":"isSuspend","text":"

\u25b8 isSuspend(): undefined | boolean

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_28","title":"Returns","text":"

undefined | boolean

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_29","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_30","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_14","title":"Parameters","text":"Name Type data Partial<CronJob>"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_31","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/","title":"Main.K8sApi.CustomResourceDefinition","text":"

@k8slens/extensions / Exports / Main / K8sApi / CustomResourceDefinition

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#class-customresourcedefinition","title":"Class: CustomResourceDefinition","text":"

Main.K8sApi.CustomResourceDefinition

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<ClusterScopedMetadata, CustomResourceDefinitionStatus, CustomResourceDefinitionSpec>

\u21b3 CustomResourceDefinition

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getConditions
  • getConversion
  • getCreationTimestamp
  • getFinalizers
  • getGroup
  • getId
  • getLabels
  • getName
  • getNames
  • getNs
  • getOwnerRefs
  • getPluralName
  • getPreferedVersion
  • getPrinterColumns
  • getResourceApiBase
  • getResourceKind
  • getResourceTitle
  • getResourceUrl
  • getResourceVersion
  • getScope
  • getScopedName
  • getSearchFields
  • getStoredVersions
  • getTimeDiffFromNow
  • getValidation
  • getVersion
  • isNamespaced
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#constructor","title":"constructor","text":"

\u2022 new CustomResourceDefinition(data)

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<ClusterScopedMetadata, CustomResourceDefinitionStatus, CustomResourceDefinitionSpec>"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#metadata","title":"metadata","text":"

\u2022 metadata: ClusterScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#spec","title":"spec","text":"

\u2022 spec: CustomResourceDefinitionSpec

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#status","title":"status","text":"

\u2022 Optional status: CustomResourceDefinitionStatus

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#apibase","title":"apiBase","text":"

\u25aa Static apiBase: string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#kind_1","title":"kind","text":"

\u25aa Static kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#namespaced","title":"namespaced","text":"

\u25aa Static namespaced: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getconditions","title":"getConditions","text":"

\u25b8 getConditions(): { isReady: boolean ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: \"True\" | \"False\" | \"Unknown\" ; tooltip: string ; type: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_13","title":"Returns","text":"

{ isReady: boolean ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: \"True\" | \"False\" | \"Unknown\" ; tooltip: string ; type: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getconversion","title":"getConversion","text":"

\u25b8 getConversion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_14","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getgroup","title":"getGroup","text":"

\u25b8 getGroup(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_18","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_19","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getnames","title":"getNames","text":"

\u25b8 getNames(): CustomResourceDefinitionNames

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_21","title":"Returns","text":"

CustomResourceDefinitionNames

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getns","title":"getNs","text":"

\u25b8 getNs(): undefined

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_22","title":"Returns","text":"

undefined

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_23","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getpluralname","title":"getPluralName","text":"

\u25b8 getPluralName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_24","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getpreferedversion","title":"getPreferedVersion","text":"

\u25b8 getPreferedVersion(): CustomResourceDefinitionVersion

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_25","title":"Returns","text":"

CustomResourceDefinitionVersion

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getprintercolumns","title":"getPrinterColumns","text":"

\u25b8 getPrinterColumns(ignorePriority?): AdditionalPrinterColumnsV1[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_13","title":"Parameters","text":"Name Type ignorePriority? boolean"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_26","title":"Returns","text":"

AdditionalPrinterColumnsV1[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getresourceapibase","title":"getResourceApiBase","text":"

\u25b8 getResourceApiBase(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_27","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getresourcekind","title":"getResourceKind","text":"

\u25b8 getResourceKind(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_28","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getresourcetitle","title":"getResourceTitle","text":"

\u25b8 getResourceTitle(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_29","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getresourceurl","title":"getResourceUrl","text":"

\u25b8 getResourceUrl(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_30","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_31","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getscope","title":"getScope","text":"

\u25b8 getScope(): \"Cluster\" | \"Namespaced\"

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_32","title":"Returns","text":"

\"Cluster\" | \"Namespaced\"

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_33","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): (undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_34","title":"Returns","text":"

(undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getstoredversions","title":"getStoredVersions","text":"

\u25b8 getStoredVersions(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_35","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_36","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getvalidation","title":"getValidation","text":"

\u25b8 getValidation(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_37","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getversion","title":"getVersion","text":"

\u25b8 getVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_38","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#isnamespaced","title":"isNamespaced","text":"

\u25b8 isNamespaced(): boolean

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_39","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_14","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_40","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_41","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_15","title":"Parameters","text":"Name Type data Partial<CustomResourceDefinition>"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_42","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/","title":"Main.K8sApi.DaemonSet","text":"

@k8slens/extensions / Exports / Main / K8sApi / DaemonSet

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#class-daemonset","title":"Class: DaemonSet","text":"

Main.K8sApi.DaemonSet

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, DaemonSetStatus, DaemonSetSpec>

\u21b3 DaemonSet

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#methods","title":"Methods","text":"
  • delete
  • getAffinity
  • getAffinityNumber
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getImages
  • getLabels
  • getName
  • getNodeSelectors
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getSelectors
  • getTemplateLabels
  • getTimeDiffFromNow
  • getTolerations
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#constructor","title":"constructor","text":"

\u2022 new DaemonSet(data)

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, DaemonSetStatus, DaemonSetSpec>"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#spec","title":"spec","text":"

\u2022 spec: DaemonSetSpec

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#status","title":"status","text":"

\u2022 Optional status: DaemonSetStatus

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#apibase","title":"apiBase","text":"

\u25aa Static apiBase: string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#kind_1","title":"kind","text":"

\u25aa Static kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#namespaced","title":"namespaced","text":"

\u25aa Static namespaced: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getaffinity","title":"getAffinity","text":"

\u25b8 getAffinity(): undefined | Affinity

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_11","title":"Returns","text":"

undefined | Affinity

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getaffinitynumber","title":"getAffinityNumber","text":"

\u25b8 getAffinityNumber(): number

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_12","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_13","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getimages","title":"getImages","text":"

\u25b8 getImages(): (undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_18","title":"Returns","text":"

(undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_19","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getnodeselectors","title":"getNodeSelectors","text":"

\u25b8 getNodeSelectors(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_21","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_23","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_24","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_25","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_26","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getselectors","title":"getSelectors","text":"

\u25b8 getSelectors(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_27","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#gettemplatelabels","title":"getTemplateLabels","text":"

\u25b8 getTemplateLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_28","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_29","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#gettolerations","title":"getTolerations","text":"

\u25b8 getTolerations(): Toleration[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_30","title":"Returns","text":"

Toleration[]

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_31","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_32","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_14","title":"Parameters","text":"Name Type data Partial<DaemonSet>"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_33","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/","title":"Main.K8sApi.Deployment","text":"

@k8slens/extensions / Exports / Main / K8sApi / Deployment

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#class-deployment","title":"Class: Deployment","text":"

Main.K8sApi.Deployment

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, DeploymentStatus, DeploymentSpec>

\u21b3 Deployment

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#methods","title":"Methods","text":"
  • delete
  • getAffinity
  • getAffinityNumber
  • getAge
  • getAnnotations
  • getConditions
  • getConditionsText
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getLabels
  • getName
  • getNodeSelectors
  • getNs
  • getOwnerRefs
  • getReplicas
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getSelectors
  • getTemplateLabels
  • getTimeDiffFromNow
  • getTolerations
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#constructor","title":"constructor","text":"

\u2022 new Deployment(data)

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, DeploymentStatus, DeploymentSpec>"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#spec","title":"spec","text":"

\u2022 spec: DeploymentSpec

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#status","title":"status","text":"

\u2022 Optional status: DeploymentStatus

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#apibase","title":"apiBase","text":"

\u25aa Static apiBase: string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#kind_1","title":"kind","text":"

\u25aa Static kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#namespaced","title":"namespaced","text":"

\u25aa Static namespaced: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getaffinity","title":"getAffinity","text":"

\u25b8 getAffinity(): undefined | Affinity

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_11","title":"Returns","text":"

undefined | Affinity

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getaffinitynumber","title":"getAffinityNumber","text":"

\u25b8 getAffinityNumber(): number

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_12","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_13","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getconditions","title":"getConditions","text":"

\u25b8 getConditions(activeOnly?): BaseKubeObjectCondition[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_13","title":"Parameters","text":"Name Type activeOnly? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_15","title":"Returns","text":"

BaseKubeObjectCondition[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getconditionstext","title":"getConditionsText","text":"

\u25b8 getConditionsText(activeOnly?): string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_14","title":"Parameters","text":"Name Type activeOnly? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_16","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_17","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_18","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_20","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_21","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getnodeselectors","title":"getNodeSelectors","text":"

\u25b8 getNodeSelectors(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_22","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_24","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getreplicas","title":"getReplicas","text":"

\u25b8 getReplicas(): number

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_25","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_26","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_27","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_28","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getselectors","title":"getSelectors","text":"

\u25b8 getSelectors(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_29","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#gettemplatelabels","title":"getTemplateLabels","text":"

\u25b8 getTemplateLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_30","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_31","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#gettolerations","title":"getTolerations","text":"

\u25b8 getTolerations(): Toleration[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_32","title":"Returns","text":"

Toleration[]

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_15","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_33","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_34","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_16","title":"Parameters","text":"Name Type data Partial<Deployment>"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_35","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/","title":"Main.K8sApi.Endpoint","text":"

@k8slens/extensions / Exports / Main / K8sApi / Endpoint

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#class-endpoint","title":"Class: Endpoint","text":"

Main.K8sApi.Endpoint

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, void, void>

\u21b3 Endpoint

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • subsets
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getEndpointSubsets
  • getFinalizers
  • getId
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • toString
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#constructor","title":"constructor","text":"

\u2022 new Endpoint(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb EndpointsData"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#overrides","title":"Overrides","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_1","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_2","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#spec","title":"spec","text":"

\u2022 spec: void

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_3","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#status","title":"status","text":"

\u2022 Optional status: void

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_4","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#subsets","title":"subsets","text":"

\u2022 Optional subsets: EndpointSubset[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#apibase","title":"apiBase","text":"

\u25aa Static apiBase: string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#overrides_1","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_5","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_6","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#kind_1","title":"kind","text":"

\u25aa Static kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#overrides_2","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#namespaced","title":"namespaced","text":"

\u25aa Static namespaced: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#overrides_3","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_13","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_14","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_15","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_16","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getendpointsubsets","title":"getEndpointSubsets","text":"

\u25b8 getEndpointSubsets(): Required<EndpointSubset>[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_14","title":"Returns","text":"

Required<EndpointSubset>[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_15","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_16","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_17","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_18","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_20","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_21","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_23","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_24","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_25","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_29","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_26","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_30","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#tostring","title":"toString","text":"

\u25b8 toString(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_27","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_14","title":"Parameters","text":"Name Type data Partial<Endpoint>"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_28","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_31","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/","title":"Main.K8sApi.HorizontalPodAutoscaler","text":"

@k8slens/extensions / Exports / Main / K8sApi / HorizontalPodAutoscaler

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#class-horizontalpodautoscaler","title":"Class: HorizontalPodAutoscaler","text":"

Main.K8sApi.HorizontalPodAutoscaler

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, HorizontalPodAutoscalerStatus, HorizontalPodAutoscalerSpec>

\u21b3 HorizontalPodAutoscaler

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getConditions
  • getCreationTimestamp
  • getCurrentMetrics
  • getFinalizers
  • getId
  • getLabels
  • getMaxPods
  • getMetrics
  • getMinPods
  • getName
  • getNs
  • getOwnerRefs
  • getReadyConditions
  • getReplicas
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#constructor","title":"constructor","text":"

\u2022 new HorizontalPodAutoscaler(data)

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, HorizontalPodAutoscalerStatus, HorizontalPodAutoscalerSpec>"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#spec","title":"spec","text":"

\u2022 spec: HorizontalPodAutoscalerSpec

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#status","title":"status","text":"

\u2022 Optional status: HorizontalPodAutoscalerStatus

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/apis/autoscaling/v2/horizontalpodautoscalers\"

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"HorizontalPodAutoscaler\"

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getconditions","title":"getConditions","text":"

\u25b8 getConditions(): { isReady: boolean ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: \"True\" | \"False\" | \"Unknown\" ; tooltip: string ; type: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_13","title":"Returns","text":"

{ isReady: boolean ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: \"True\" | \"False\" | \"Unknown\" ; tooltip: string ; type: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getcurrentmetrics","title":"getCurrentMetrics","text":"

\u25b8 getCurrentMetrics(): HorizontalPodAutoscalerMetricStatus[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_15","title":"Returns","text":"

HorizontalPodAutoscalerMetricStatus[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_18","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getmaxpods","title":"getMaxPods","text":"

\u25b8 getMaxPods(): number

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_19","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getmetrics","title":"getMetrics","text":"

\u25b8 getMetrics(): HorizontalPodAutoscalerMetricSpec[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_20","title":"Returns","text":"

HorizontalPodAutoscalerMetricSpec[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getminpods","title":"getMinPods","text":"

\u25b8 getMinPods(): number

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_21","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_24","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getreadyconditions","title":"getReadyConditions","text":"

\u25b8 getReadyConditions(): { isReady: boolean ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: \"True\" | \"False\" | \"Unknown\" ; tooltip: string ; type: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_25","title":"Returns","text":"

{ isReady: boolean ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: \"True\" | \"False\" | \"Unknown\" ; tooltip: string ; type: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getreplicas","title":"getReplicas","text":"

\u25b8 getReplicas(): number

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_26","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_27","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_28","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_29","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_30","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_31","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_32","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_14","title":"Parameters","text":"Name Type data Partial<HorizontalPodAutoscaler>"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_33","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/","title":"Main.K8sApi.Ingress","text":"

@k8slens/extensions / Exports / Main / K8sApi / Ingress

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#class-ingress","title":"Class: Ingress","text":"

Main.K8sApi.Ingress

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, IngressStatus, IngressSpec>

\u21b3 Ingress

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getHosts
  • getId
  • getLabels
  • getLoadBalancers
  • getName
  • getNs
  • getOwnerRefs
  • getPorts
  • getResourceVersion
  • getRoutes
  • getRules
  • getScopedName
  • getSearchFields
  • getServiceNamePort
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#constructor","title":"constructor","text":"

\u2022 new Ingress(data)

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, IngressStatus, IngressSpec>"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#spec","title":"spec","text":"

\u2022 spec: IngressSpec

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#status","title":"status","text":"

\u2022 Optional status: IngressStatus

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/apis/networking.k8s.io/v1/ingresses\"

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"Ingress\"

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#gethosts","title":"getHosts","text":"

\u25b8 getHosts(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_15","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_16","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_17","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getloadbalancers","title":"getLoadBalancers","text":"

\u25b8 getLoadBalancers(): (undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_18","title":"Returns","text":"

(undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_21","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getports","title":"getPorts","text":"

\u25b8 getPorts(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getroutes","title":"getRoutes","text":"

\u25b8 getRoutes(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_24","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getrules","title":"getRules","text":"

\u25b8 getRules(): IngressRule[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_25","title":"Returns","text":"

IngressRule[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_26","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_27","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getservicenameport","title":"getServiceNamePort","text":"

\u25b8 getServiceNamePort(): undefined | ExtensionsBackend

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_28","title":"Returns","text":"

undefined | ExtensionsBackend

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_29","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_30","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_31","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_14","title":"Parameters","text":"Name Type data Partial<Ingress>"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_32","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.Job/","title":"Main.K8sApi.Job","text":"

@k8slens/extensions / Exports / Main / K8sApi / Job

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#class-job","title":"Class: Job","text":"

Main.K8sApi.Job

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, JobStatus, JobSpec>

\u21b3 Job

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.Job/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#methods","title":"Methods","text":"
  • delete
  • getAffinity
  • getAffinityNumber
  • getAge
  • getAnnotations
  • getCompletions
  • getCondition
  • getCreationTimestamp
  • getDesiredCompletions
  • getFinalizers
  • getId
  • getImages
  • getLabels
  • getName
  • getNodeSelectors
  • getNs
  • getOwnerRefs
  • getParallelism
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getSelectors
  • getTemplateLabels
  • getTimeDiffFromNow
  • getTolerations
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Job/#constructor","title":"constructor","text":"

\u2022 new Job(data)

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, JobStatus, JobSpec>"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Job/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#spec","title":"spec","text":"

\u2022 spec: JobSpec

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#status","title":"status","text":"

\u2022 Optional status: JobStatus

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/apis/batch/v1/jobs\"

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Job/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"Job\"

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Job/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Job/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getaffinity","title":"getAffinity","text":"

\u25b8 getAffinity(): undefined | Affinity

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_11","title":"Returns","text":"

undefined | Affinity

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getaffinitynumber","title":"getAffinityNumber","text":"

\u25b8 getAffinityNumber(): number

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_12","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_13","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getcompletions","title":"getCompletions","text":"

\u25b8 getCompletions(): number

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getcondition","title":"getCondition","text":"

\u25b8 getCondition(): undefined | BaseKubeObjectCondition

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_16","title":"Returns","text":"

undefined | BaseKubeObjectCondition

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_17","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getdesiredcompletions","title":"getDesiredCompletions","text":"

\u25b8 getDesiredCompletions(): number

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_18","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_19","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getimages","title":"getImages","text":"

\u25b8 getImages(): (undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_21","title":"Returns","text":"

(undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_22","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getnodeselectors","title":"getNodeSelectors","text":"

\u25b8 getNodeSelectors(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_24","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_25","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_26","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getparallelism","title":"getParallelism","text":"

\u25b8 getParallelism(): undefined | number

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_27","title":"Returns","text":"

undefined | number

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_28","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_29","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_30","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getselectors","title":"getSelectors","text":"

\u25b8 getSelectors(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_31","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#gettemplatelabels","title":"getTemplateLabels","text":"

\u25b8 getTemplateLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_32","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_33","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#gettolerations","title":"getTolerations","text":"

\u25b8 getTolerations(): Toleration[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_34","title":"Returns","text":"

Toleration[]

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_35","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_36","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_14","title":"Parameters","text":"Name Type data Partial<Job>"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_37","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/","title":"Main.K8sApi.KubeEvent","text":"

@k8slens/extensions / Exports / Main / K8sApi / KubeEvent

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#class-kubeevent","title":"Class: KubeEvent","text":"

Main.K8sApi.KubeEvent

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<KubeObjectMetadata<KubeObjectScope.Namespace>, void, void>

\u21b3 KubeEvent

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#properties","title":"Properties","text":"
  • action
  • apiVersion
  • count
  • eventTime
  • firstTimestamp
  • involvedObject
  • kind
  • lastTimestamp
  • message
  • metadata
  • reason
  • related
  • reportingComponent
  • reportingInstance
  • series
  • source
  • spec
  • status
  • type
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getFirstSeenTime
  • getId
  • getLabels
  • getLastSeenTime
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getSource
  • getTimeDiffFromNow
  • isWarning
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#constructor","title":"constructor","text":"

\u2022 new KubeEvent(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeEventData"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#overrides","title":"Overrides","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#action","title":"action","text":"

\u2022 Optional action: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#count","title":"count","text":"

\u2022 Optional count: number

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#eventtime","title":"eventTime","text":"

\u2022 Optional eventTime: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#firsttimestamp","title":"firstTimestamp","text":"

\u2022 Optional firstTimestamp: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#involvedobject","title":"involvedObject","text":"

\u2022 involvedObject: Required<ObjectReference>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_1","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#lasttimestamp","title":"lastTimestamp","text":"

\u2022 Optional lastTimestamp: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#message","title":"message","text":"

\u2022 Optional message: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#metadata","title":"metadata","text":"

\u2022 metadata: KubeObjectMetadata<Namespace>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_2","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#reason","title":"reason","text":"

\u2022 Optional reason: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#related","title":"related","text":"

\u2022 Optional related: ObjectReference

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#reportingcomponent","title":"reportingComponent","text":"

\u2022 Optional reportingComponent: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#reportinginstance","title":"reportingInstance","text":"

\u2022 Optional reportingInstance: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#series","title":"series","text":"

\u2022 Optional series: EventSeries

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#source","title":"source","text":"

\u2022 Optional source: EventSource

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#spec","title":"spec","text":"

\u2022 spec: void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_3","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#status","title":"status","text":"

\u2022 Optional status: void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_4","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type","title":"type","text":"

\u2022 Optional type: string

Current supported values are: - \"Normal\" - \"Warning\"

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#apibase","title":"apiBase","text":"

\u25aa Static apiBase: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#overrides_1","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_5","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_6","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#kind_1","title":"kind","text":"

\u25aa Static kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#overrides_2","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#namespaced","title":"namespaced","text":"

\u25aa Static namespaced: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#overrides_3","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_13","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_14","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_15","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_16","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getfirstseentime","title":"getFirstSeenTime","text":"

\u25b8 getFirstSeenTime(): string

Deprecated

This function is not reactive to changing of time. If rendering use <ReactiveDuration /> instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_16","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_17","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getlastseentime","title":"getLastSeenTime","text":"

\u25b8 getLastSeenTime(): string

Deprecated

This function is not reactive to changing of time. If rendering use <ReactiveDuration /> instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_18","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_21","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_24","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getsource","title":"getSource","text":"

\u25b8 getSource(): string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_25","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_26","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#iswarning","title":"isWarning","text":"

\u25b8 isWarning(): boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_27","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_28","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_29","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_29","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_30","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_14","title":"Parameters","text":"Name Type data Partial<KubeEvent>"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_30","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_31","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/","title":"Main.K8sApi.KubeObject","text":"

@k8slens/extensions / Exports / Main / K8sApi / KubeObject

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#class-kubeobjectmetadata-status-spec","title":"Class: KubeObject<Metadata, Status, Spec>","text":"

Main.K8sApi.KubeObject

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#hierarchy","title":"Hierarchy","text":"
  • KubeObject

\u21b3 Pod

\u21b3 Node

\u21b3 Deployment

\u21b3 DaemonSet

\u21b3 StatefulSet

\u21b3 Job

\u21b3 CronJob

\u21b3 ConfigMap

\u21b3 Secret

\u21b3 ReplicaSet

\u21b3 ResourceQuota

\u21b3 LimitRange

\u21b3 HorizontalPodAutoscaler

\u21b3 PodDisruptionBudget

\u21b3 PriorityClass

\u21b3 Service

\u21b3 Endpoint

\u21b3 Ingress

\u21b3 NetworkPolicy

\u21b3 PersistentVolume

\u21b3 PersistentVolumeClaim

\u21b3 StorageClass

\u21b3 Namespace

\u21b3 KubeEvent

\u21b3 ServiceAccount

\u21b3 Role

\u21b3 RoleBinding

\u21b3 ClusterRole

\u21b3 ClusterRoleBinding

\u21b3 CustomResourceDefinition

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#constructor","title":"constructor","text":"

\u2022 new KubeObject<Metadata, Status, Spec>(data)

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-parameters_1","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#metadata","title":"metadata","text":"

\u2022 metadata: Metadata

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#spec","title":"spec","text":"

\u2022 spec: Spec

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#status","title":"status","text":"

\u2022 Optional status: Status

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#apibase","title":"apiBase","text":"

\u25aa Static Optional Readonly apiBase: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-parameters_2","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-parameters_3","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#kind_1","title":"kind","text":"

\u25aa Static Optional Readonly kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#namespaced","title":"namespaced","text":"

\u25aa Static Optional Readonly namespaced: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getns","title":"getNs","text":"

\u25b8 getNs(): Metadata[\"namespace\"]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_18","title":"Returns","text":"

Metadata[\"namespace\"]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: Metadata[\"namespace\"] ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_19","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: Metadata[\"namespace\"] ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_21","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): (string | Metadata[\"namespace\"])[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_22","title":"Returns","text":"

(string | Metadata[\"namespace\"])[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_23","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_24","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_25","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_14","title":"Parameters","text":"Name Type data Partial<KubeObject<Metadata, Status, Spec>>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_26","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/","title":"Main.K8sApi.KubeObjectStore","text":"

@k8slens/extensions / Exports / Main / K8sApi / KubeObjectStore

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#class-kubeobjectstorek-a-d","title":"Class: KubeObjectStore<K, A, D>","text":"

Main.K8sApi.KubeObjectStore

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#type-parameters","title":"Type parameters","text":"Name Type K extends KubeObject = KubeObject A extends InternalKubeApi<K, D> = InternalKubeApi<K, KubeJsonApiDataFor<K>> D extends KubeJsonApiDataFor<K> = KubeApiDataFrom<K, A>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<K, A, D>

\u21b3 KubeObjectStore

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
  • context
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#accessors","title":"Accessors","text":"
  • context
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#constructor","title":"constructor","text":"

\u2022 new KubeObjectStore<K, A, D>(api, opts?)

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#type-parameters_1","title":"Type parameters","text":"Name Type K extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, K> = KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> A extends KubeApi<K, D, A> = KubeApi<K, KubeJsonApiDataFor<K>> D extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, D> = KubeApiDataFrom<K, A>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters","title":"Parameters","text":"Name Type api A opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#overrides","title":"Overrides","text":"

InternalKubeObjectStore<K, A, D\\>.constructor

\u2022 new KubeObjectStore<K, A, D>()

Deprecated

Supply API instance through constructor

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#type-parameters_2","title":"Type parameters","text":"Name Type K extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, K> = KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> A extends KubeApi<K, D, A> = KubeApi<K, KubeJsonApiDataFor<K>> D extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, D> = KubeApiDataFrom<K, A>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#overrides_1","title":"Overrides","text":"

InternalKubeObjectStore<K, A, D\\>.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#api","title":"api","text":"

\u2022 Readonly api: A

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from","title":"Inherited from","text":"

InternalKubeObjectStore.api

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_1","title":"Inherited from","text":"

InternalKubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: K) => string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_1","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_2","title":"Inherited from","text":"

InternalKubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_3","title":"Inherited from","text":"

InternalKubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<D>>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_4","title":"Inherited from","text":"

InternalKubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_5","title":"Inherited from","text":"

InternalKubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_6","title":"Inherited from","text":"

InternalKubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_7","title":"Inherited from","text":"

InternalKubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#items","title":"items","text":"

\u2022 items: IObservableArray<K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_8","title":"Inherited from","text":"

InternalKubeObjectStore.items

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_9","title":"Inherited from","text":"

InternalKubeObjectStore.limit

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_10","title":"Inherited from","text":"

InternalKubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#context","title":"context","text":"

\u25aa Static Readonly context: Object

Deprecated

This is no longer used and shouldn't have been every really used

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#type-declaration_1","title":"Type declaration","text":"Name Type get () => ClusterContext set (ctx: ClusterContext) => void"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#context_1","title":"context","text":"

\u2022 get context(): ClusterContext

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_1","title":"Returns","text":"

ClusterContext

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_2","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_11","title":"Inherited from","text":"

InternalKubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_3","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_12","title":"Inherited from","text":"

InternalKubeObjectStore.query

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_4","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_13","title":"Inherited from","text":"

InternalKubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<K, void, undefined>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_5","title":"Returns","text":"

Generator<K, void, undefined>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_14","title":"Inherited from","text":"

InternalKubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_6","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_15","title":"Inherited from","text":"

InternalKubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialDeep<K, {}>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_7","title":"Returns","text":"

Promise<K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_16","title":"Inherited from","text":"

InternalKubeObjectStore.create

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialDeep<K, {}>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_8","title":"Returns","text":"

Promise<null | K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_17","title":"Inherited from","text":"

InternalKubeObjectStore.createItem

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_5","title":"Parameters","text":"Name Type items K[]"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_9","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_18","title":"Inherited from","text":"

InternalKubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_10","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_19","title":"Inherited from","text":"

InternalKubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | K

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_11","title":"Returns","text":"

undefined | K

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_20","title":"Inherited from","text":"

InternalKubeObjectStore.getById

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_12","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_21","title":"Inherited from","text":"

InternalKubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | K

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_13","title":"Returns","text":"

undefined | K

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_22","title":"Inherited from","text":"

InternalKubeObjectStore.getByName

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | K

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_14","title":"Returns","text":"

undefined | K

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_23","title":"Inherited from","text":"

InternalKubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_24","title":"Inherited from","text":"

InternalKubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_16","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_25","title":"Inherited from","text":"

InternalKubeObjectStore.getItems

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_17","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_26","title":"Inherited from","text":"

InternalKubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_12","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_27","title":"Inherited from","text":"

InternalKubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? K[]"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_19","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_28","title":"Inherited from","text":"

InternalKubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#load","title":"load","text":"

\u25b8 load(params): Promise<K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_20","title":"Returns","text":"

Promise<K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_29","title":"Inherited from","text":"

InternalKubeObjectStore.load

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | K[]>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_21","title":"Returns","text":"

Promise<undefined | K[]>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_30","title":"Inherited from","text":"

InternalKubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_22","title":"Returns","text":"

Promise<K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_31","title":"Inherited from","text":"

InternalKubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_23","title":"Returns","text":"

Promise<null | K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_32","title":"Inherited from","text":"

InternalKubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<K[]>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_24","title":"Returns","text":"

Promise<K[]>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_33","title":"Inherited from","text":"

InternalKubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_19","title":"Parameters","text":"Name Type partialItems K[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_25","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_34","title":"Inherited from","text":"

InternalKubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_20","title":"Parameters","text":"Name Type item K patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_26","title":"Returns","text":"

Promise<K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_35","title":"Inherited from","text":"

InternalKubeObjectStore.patch

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_21","title":"Parameters","text":"Name Type items K[]"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_27","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_36","title":"Inherited from","text":"

InternalKubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | K[]>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_28","title":"Returns","text":"

Promise<undefined | K[]>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_37","title":"Inherited from","text":"

InternalKubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_23","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_38","title":"Inherited from","text":"

InternalKubeObjectStore.remove

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_24","title":"Parameters","text":"Name Type item K request () => Promise<any>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_39","title":"Inherited from","text":"

InternalKubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_25","title":"Parameters","text":"Name Type items K[]"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_40","title":"Inherited from","text":"

InternalKubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_32","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_41","title":"Inherited from","text":"

InternalKubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_42","title":"Inherited from","text":"

InternalKubeObjectStore.reset

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_43","title":"Inherited from","text":"

InternalKubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_44","title":"Inherited from","text":"

InternalKubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_27","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_36","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_45","title":"Inherited from","text":"

InternalKubeObjectStore.select

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): K[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_28","title":"Parameters","text":"Name Type Description items? K[] the items to be sorted (default: the current items in this store) sorting? (item: K) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_37","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_46","title":"Inherited from","text":"

InternalKubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_38","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_47","title":"Inherited from","text":"

InternalKubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_30","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_48","title":"Inherited from","text":"

InternalKubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? K[]"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_49","title":"Inherited from","text":"

InternalKubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_32","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_41","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_50","title":"Inherited from","text":"

InternalKubeObjectStore.unselect

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_33","title":"Parameters","text":"Name Type item K data PartialDeep<K, {}>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_42","title":"Returns","text":"

Promise<K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_51","title":"Inherited from","text":"

InternalKubeObjectStore.update

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_43","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_52","title":"Inherited from","text":"

InternalKubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters_34","title":"Parameters","text":"Name Type item K request () => Promise<K>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_44","title":"Returns","text":"

Promise<K>

"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#inherited-from_53","title":"Inherited from","text":"

InternalKubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/","title":"Main.K8sApi.KubeStatus","text":"

@k8slens/extensions / Exports / Main / K8sApi / KubeStatus

"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#class-kubestatus","title":"Class: KubeStatus","text":"

Main.K8sApi.KubeStatus

"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#properties","title":"Properties","text":"
  • apiVersion
  • code
  • kind
  • message
  • reason
  • status
"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#methods","title":"Methods","text":"
  • getExplanation
"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#constructor","title":"constructor","text":"

\u2022 new KubeStatus(data)

"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#parameters","title":"Parameters","text":"Name Type data KubeStatusData"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#apiversion","title":"apiVersion","text":"

\u2022 Readonly apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#code","title":"code","text":"

\u2022 Readonly code: number

"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#kind","title":"kind","text":"

\u2022 Readonly kind: \"Status\"

"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#message","title":"message","text":"

\u2022 Readonly message: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#reason","title":"reason","text":"

\u2022 Readonly reason: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#status","title":"status","text":"

\u2022 Readonly status: string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#getexplanation","title":"getExplanation","text":"

\u25b8 getExplanation(): string

"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/","title":"Main.K8sApi.LimitRange","text":"

@k8slens/extensions / Exports / Main / K8sApi / LimitRange

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#class-limitrange","title":"Class: LimitRange","text":"

Main.K8sApi.LimitRange

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, void, LimitRangeSpec>

\u21b3 LimitRange

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getContainerLimits
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getPVCLimits
  • getPodLimits
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#constructor","title":"constructor","text":"

\u2022 new LimitRange(data)

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, void, LimitRangeSpec>"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#spec","title":"spec","text":"

\u2022 spec: LimitRangeSpec

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#status","title":"status","text":"

\u2022 Optional status: void

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/api/v1/limitranges\"

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"LimitRange\"

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getcontainerlimits","title":"getContainerLimits","text":"

\u25b8 getContainerLimits(): LimitRangeItem[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_13","title":"Returns","text":"

LimitRangeItem[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_15","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_16","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_17","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_18","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_20","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getpvclimits","title":"getPVCLimits","text":"

\u25b8 getPVCLimits(): LimitRangeItem[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_21","title":"Returns","text":"

LimitRangeItem[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getpodlimits","title":"getPodLimits","text":"

\u25b8 getPodLimits(): LimitRangeItem[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_22","title":"Returns","text":"

LimitRangeItem[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_24","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_25","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_26","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_27","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_28","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_14","title":"Parameters","text":"Name Type data Partial<LimitRange>"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_29","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/","title":"Main.K8sApi.Namespace","text":"

@k8slens/extensions / Exports / Main / K8sApi / Namespace

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#class-namespace","title":"Class: Namespace","text":"

Main.K8sApi.Namespace

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<ClusterScopedMetadata, NamespaceStatus, NamespaceSpec>

\u21b3 Namespace

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getStatus
  • getTimeDiffFromNow
  • isChildOf
  • isControlledByHNC
  • isSubnamespace
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#constructor","title":"constructor","text":"

\u2022 new Namespace(data)

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<ClusterScopedMetadata, NamespaceStatus, NamespaceSpec>"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#metadata","title":"metadata","text":"

\u2022 metadata: ClusterScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#spec","title":"spec","text":"

\u2022 spec: NamespaceSpec

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#status","title":"status","text":"

\u2022 Optional status: NamespaceStatus

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/api/v1/namespaces\"

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"Namespace\"

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: false

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getns","title":"getNs","text":"

\u25b8 getNs(): undefined

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_18","title":"Returns","text":"

undefined

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_19","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_21","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): (undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_22","title":"Returns","text":"

(undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getstatus","title":"getStatus","text":"

\u25b8 getStatus(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_24","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#ischildof","title":"isChildOf","text":"

\u25b8 isChildOf(parentName): undefined | string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_13","title":"Parameters","text":"Name Type parentName string"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_25","title":"Returns","text":"

undefined | string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#iscontrolledbyhnc","title":"isControlledByHNC","text":"

\u25b8 isControlledByHNC(): boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_26","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#issubnamespace","title":"isSubnamespace","text":"

\u25b8 isSubnamespace(): undefined | string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_27","title":"Returns","text":"

undefined | string

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_14","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_28","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_29","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_15","title":"Parameters","text":"Name Type data Partial<Namespace>"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_30","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/","title":"Main.K8sApi.NetworkPolicy","text":"

@k8slens/extensions / Exports / Main / K8sApi / NetworkPolicy

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#class-networkpolicy","title":"Class: NetworkPolicy","text":"

Main.K8sApi.NetworkPolicy

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, void, NetworkPolicySpec>

\u21b3 NetworkPolicy

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getLabels
  • getMatchLabels
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getTimeDiffFromNow
  • getTypes
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#constructor","title":"constructor","text":"

\u2022 new NetworkPolicy(data)

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, void, NetworkPolicySpec>"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#spec","title":"spec","text":"

\u2022 spec: NetworkPolicySpec

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#status","title":"status","text":"

\u2022 Optional status: void

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/apis/networking.k8s.io/v1/networkpolicies\"

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"NetworkPolicy\"

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getmatchlabels","title":"getMatchLabels","text":"

\u25b8 getMatchLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_17","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_18","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_20","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_21","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_23","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_24","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#gettypes","title":"getTypes","text":"

\u25b8 getTypes(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_25","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_26","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_27","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_14","title":"Parameters","text":"Name Type data Partial<NetworkPolicy>"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_28","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.Node/","title":"Main.K8sApi.Node","text":"

@k8slens/extensions / Exports / Main / K8sApi / Node

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#class-node","title":"Class: Node","text":"

Main.K8sApi.Node

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<ClusterScopedMetadata, NodeStatus, NodeSpec>

\u21b3 Node

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.Node/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#methods","title":"Methods","text":"
  • delete
  • getActiveConditions
  • getAge
  • getAnnotations
  • getConditions
  • getCpuCapacity
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getKubeletVersion
  • getLabels
  • getMemoryCapacity
  • getName
  • getNodeConditionText
  • getNs
  • getOperatingSystem
  • getOwnerRefs
  • getResourceVersion
  • getRoleLabelItems
  • getRoleLabels
  • getScopedName
  • getSearchFields
  • getTaints
  • getTimeDiffFromNow
  • getWarningConditions
  • isMasterNode
  • isUnschedulable
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Node/#constructor","title":"constructor","text":"

\u2022 new Node(data)

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<ClusterScopedMetadata, NodeStatus, NodeSpec>"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Node/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#metadata","title":"metadata","text":"

\u2022 metadata: ClusterScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#spec","title":"spec","text":"

\u2022 spec: NodeSpec

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#status","title":"status","text":"

\u2022 Optional status: NodeStatus

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/api/v1/nodes\"

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Node/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"Node\"

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: false

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Node/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Node/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getactiveconditions","title":"getActiveConditions","text":"

\u25b8 getActiveConditions(): NodeCondition[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_11","title":"Returns","text":"

NodeCondition[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_12","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_13","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getconditions","title":"getConditions","text":"

\u25b8 getConditions(): NodeCondition[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_14","title":"Returns","text":"

NodeCondition[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getcpucapacity","title":"getCpuCapacity","text":"

\u25b8 getCpuCapacity(): undefined | number

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_15","title":"Returns","text":"

undefined | number

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_17","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_18","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getkubeletversion","title":"getKubeletVersion","text":"

\u25b8 getKubeletVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_20","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getmemorycapacity","title":"getMemoryCapacity","text":"

\u25b8 getMemoryCapacity(): number

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_21","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getnodeconditiontext","title":"getNodeConditionText","text":"

\u25b8 getNodeConditionText(): string

Returns the concatination of all current condition types which have a status of \"True\"

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getns","title":"getNs","text":"

\u25b8 getNs(): undefined

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_24","title":"Returns","text":"

undefined

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getoperatingsystem","title":"getOperatingSystem","text":"

\u25b8 getOperatingSystem(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_25","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_26","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_27","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getrolelabelitems","title":"getRoleLabelItems","text":"

\u25b8 getRoleLabelItems(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_28","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getrolelabels","title":"getRoleLabels","text":"

\u25b8 getRoleLabels(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_29","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_30","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): (undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_31","title":"Returns","text":"

(undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#gettaints","title":"getTaints","text":"

\u25b8 getTaints(): NodeTaint[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_32","title":"Returns","text":"

NodeTaint[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_33","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getwarningconditions","title":"getWarningConditions","text":"

\u25b8 getWarningConditions(): NodeCondition[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_34","title":"Returns","text":"

NodeCondition[]

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#ismasternode","title":"isMasterNode","text":"

\u25b8 isMasterNode(): boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_35","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#isunschedulable","title":"isUnschedulable","text":"

\u25b8 isUnschedulable(): undefined | boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_36","title":"Returns","text":"

undefined | boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_37","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_38","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_14","title":"Parameters","text":"Name Type data Partial<Node>"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_39","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/","title":"Main.K8sApi.PersistentVolume","text":"

@k8slens/extensions / Exports / Main / K8sApi / PersistentVolume

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#class-persistentvolume","title":"Class: PersistentVolume","text":"

Main.K8sApi.PersistentVolume

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<ClusterScopedMetadata, PersistentVolumeStatus, PersistentVolumeSpec>

\u21b3 PersistentVolume

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCapacity
  • getClaimRefName
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getStatus
  • getStorageClass
  • getStorageClassName
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#constructor","title":"constructor","text":"

\u2022 new PersistentVolume(data)

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<ClusterScopedMetadata, PersistentVolumeStatus, PersistentVolumeSpec>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#metadata","title":"metadata","text":"

\u2022 metadata: ClusterScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#spec","title":"spec","text":"

\u2022 spec: PersistentVolumeSpec

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#status","title":"status","text":"

\u2022 Optional status: PersistentVolumeStatus

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#apibase","title":"apiBase","text":"

\u25aa Static apiBase: string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#kind_1","title":"kind","text":"

\u25aa Static kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#namespaced","title":"namespaced","text":"

\u25aa Static namespaced: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getcapacity","title":"getCapacity","text":"

\u25b8 getCapacity(inBytes?): string | number

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_13","title":"Parameters","text":"Name Type inBytes? boolean"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_13","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getclaimrefname","title":"getClaimRefName","text":"

\u25b8 getClaimRefName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_14","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_18","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getns","title":"getNs","text":"

\u25b8 getNs(): undefined

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_20","title":"Returns","text":"

undefined

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_21","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): (undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_24","title":"Returns","text":"

(undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getstatus","title":"getStatus","text":"

\u25b8 getStatus(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_25","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getstorageclass","title":"getStorageClass","text":"

\u25b8 getStorageClass(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_26","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getstorageclassname","title":"getStorageClassName","text":"

\u25b8 getStorageClassName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_27","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_28","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_14","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_29","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_30","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_15","title":"Parameters","text":"Name Type data Partial<PersistentVolume>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_31","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/","title":"Main.K8sApi.PersistentVolumeClaim","text":"

@k8slens/extensions / Exports / Main / K8sApi / PersistentVolumeClaim

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#class-persistentvolumeclaim","title":"Class: PersistentVolumeClaim","text":"

Main.K8sApi.PersistentVolumeClaim

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, PersistentVolumeClaimStatus, PersistentVolumeClaimSpec>

\u21b3 PersistentVolumeClaim

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getLabels
  • getMatchExpressions
  • getMatchLabels
  • getName
  • getNs
  • getOwnerRefs
  • getPods
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getStatus
  • getStorage
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#constructor","title":"constructor","text":"

\u2022 new PersistentVolumeClaim(data)

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, PersistentVolumeClaimStatus, PersistentVolumeClaimSpec>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#spec","title":"spec","text":"

\u2022 spec: PersistentVolumeClaimSpec

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#status","title":"status","text":"

\u2022 Optional status: PersistentVolumeClaimStatus

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/api/v1/persistentvolumeclaims\"

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"PersistentVolumeClaim\"

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getmatchexpressions","title":"getMatchExpressions","text":"

\u25b8 getMatchExpressions(): LabelMatchExpression[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_17","title":"Returns","text":"

LabelMatchExpression[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getmatchlabels","title":"getMatchLabels","text":"

\u25b8 getMatchLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_18","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_21","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getpods","title":"getPods","text":"

\u25b8 getPods(pods): Pod[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_13","title":"Parameters","text":"Name Type pods Pod[]"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_22","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_24","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_25","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getstatus","title":"getStatus","text":"

\u25b8 getStatus(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_26","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getstorage","title":"getStorage","text":"

\u25b8 getStorage(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_27","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_28","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_14","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_29","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_30","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_15","title":"Parameters","text":"Name Type data Partial<PersistentVolumeClaim>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_31","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/","title":"Main.K8sApi.Pod","text":"

@k8slens/extensions / Exports / Main / K8sApi / Pod

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#class-pod","title":"Class: Pod","text":"

Main.K8sApi.Pod

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, PodStatus, PodSpec>

\u21b3 Pod

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.Pod/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#methods","title":"Methods","text":"
  • delete
  • getAffinity
  • getAffinityNumber
  • getAge
  • getAllContainers
  • getAnnotations
  • getConditions
  • getContainerStatuses
  • getContainers
  • getCreationTimestamp
  • getFinalizers
  • getIPs
  • getId
  • getInitContainers
  • getLabels
  • getLivenessProbe
  • getName
  • getNodeName
  • getNodeSelectors
  • getNs
  • getOwnerRefs
  • getPriorityClassName
  • getQosClass
  • getReadinessProbe
  • getReason
  • getResourceVersion
  • getRestartsCount
  • getRunningContainers
  • getRuntimeClassName
  • getScopedName
  • getSearchFields
  • getSecrets
  • getSelectedNodeOs
  • getServiceAccountName
  • getStartupProbe
  • getStatus
  • getStatusMessage
  • getStatusPhase
  • getTimeDiffFromNow
  • getTolerations
  • getVolumes
  • hasIssues
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Pod/#constructor","title":"constructor","text":"

\u2022 new Pod(data)

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, PodStatus, PodSpec>"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Pod/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#spec","title":"spec","text":"

\u2022 spec: PodSpec

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#status","title":"status","text":"

\u2022 Optional status: PodStatus

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#apibase","title":"apiBase","text":"

\u25aa Static apiBase: string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#kind_1","title":"kind","text":"

\u25aa Static kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#namespaced","title":"namespaced","text":"

\u25aa Static namespaced: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Pod/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Pod/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getaffinity","title":"getAffinity","text":"

\u25b8 getAffinity(): Affinity

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_11","title":"Returns","text":"

Affinity

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getaffinitynumber","title":"getAffinityNumber","text":"

\u25b8 getAffinityNumber(): number

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_12","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_13","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getallcontainers","title":"getAllContainers","text":"

\u25b8 getAllContainers(): IPodContainer[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_14","title":"Returns","text":"

IPodContainer[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_15","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getconditions","title":"getConditions","text":"

\u25b8 getConditions(): PodCondition[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_16","title":"Returns","text":"

PodCondition[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getcontainerstatuses","title":"getContainerStatuses","text":"

\u25b8 getContainerStatuses(includeInitContainers?): IPodContainerStatus[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_13","title":"Parameters","text":"Name Type includeInitContainers? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_17","title":"Returns","text":"

IPodContainerStatus[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getcontainers","title":"getContainers","text":"

\u25b8 getContainers(): IPodContainer[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_18","title":"Returns","text":"

IPodContainer[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_19","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_20","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getips","title":"getIPs","text":"

\u25b8 getIPs(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_21","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getinitcontainers","title":"getInitContainers","text":"

\u25b8 getInitContainers(): IPodContainer[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_23","title":"Returns","text":"

IPodContainer[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_24","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getlivenessprobe","title":"getLivenessProbe","text":"

\u25b8 getLivenessProbe(container): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_14","title":"Parameters","text":"Name Type container IPodContainer"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_25","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_26","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getnodename","title":"getNodeName","text":"

\u25b8 getNodeName(): undefined | string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_27","title":"Returns","text":"

undefined | string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getnodeselectors","title":"getNodeSelectors","text":"

\u25b8 getNodeSelectors(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_28","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_29","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_30","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getpriorityclassname","title":"getPriorityClassName","text":"

\u25b8 getPriorityClassName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_31","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getqosclass","title":"getQosClass","text":"

\u25b8 getQosClass(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_32","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getreadinessprobe","title":"getReadinessProbe","text":"

\u25b8 getReadinessProbe(container): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_15","title":"Parameters","text":"Name Type container IPodContainer"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_33","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getreason","title":"getReason","text":"

\u25b8 getReason(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_34","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_35","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getrestartscount","title":"getRestartsCount","text":"

\u25b8 getRestartsCount(): number

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_36","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getrunningcontainers","title":"getRunningContainers","text":"

\u25b8 getRunningContainers(): IPodContainer[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_37","title":"Returns","text":"

IPodContainer[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getruntimeclassname","title":"getRuntimeClassName","text":"

\u25b8 getRuntimeClassName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_38","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_39","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_40","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getsecrets","title":"getSecrets","text":"

\u25b8 getSecrets(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_41","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getselectednodeos","title":"getSelectedNodeOs","text":"

\u25b8 getSelectedNodeOs(): undefined | string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_42","title":"Returns","text":"

undefined | string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getserviceaccountname","title":"getServiceAccountName","text":"

\u25b8 getServiceAccountName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_43","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getstartupprobe","title":"getStartupProbe","text":"

\u25b8 getStartupProbe(container): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_16","title":"Parameters","text":"Name Type container IPodContainer"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_44","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getstatus","title":"getStatus","text":"

\u25b8 getStatus(): PodStatusPhase

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_45","title":"Returns","text":"

PodStatusPhase

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getstatusmessage","title":"getStatusMessage","text":"

\u25b8 getStatusMessage(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_46","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getstatusphase","title":"getStatusPhase","text":"

\u25b8 getStatusPhase(): undefined | string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_47","title":"Returns","text":"

undefined | string

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_48","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#gettolerations","title":"getTolerations","text":"

\u25b8 getTolerations(): Toleration[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_49","title":"Returns","text":"

Toleration[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getvolumes","title":"getVolumes","text":"

\u25b8 getVolumes(): PodSpecVolume[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_50","title":"Returns","text":"

PodSpecVolume[]

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#hasissues","title":"hasIssues","text":"

\u25b8 hasIssues(): boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_51","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_17","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_52","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_53","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_18","title":"Parameters","text":"Name Type data Partial<Pod>"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_54","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/","title":"Main.K8sApi.PodDisruptionBudget","text":"

@k8slens/extensions / Exports / Main / K8sApi / PodDisruptionBudget

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#class-poddisruptionbudget","title":"Class: PodDisruptionBudget","text":"

Main.K8sApi.PodDisruptionBudget

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, PodDisruptionBudgetStatus, PodDisruptionBudgetSpec>

\u21b3 PodDisruptionBudget

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getCurrentHealthy
  • getDesiredHealthy
  • getFinalizers
  • getId
  • getLabels
  • getMaxUnavailable
  • getMinAvailable
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getSelectors
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#constructor","title":"constructor","text":"

\u2022 new PodDisruptionBudget(data)

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, PodDisruptionBudgetStatus, PodDisruptionBudgetSpec>"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#spec","title":"spec","text":"

\u2022 spec: PodDisruptionBudgetSpec

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#status","title":"status","text":"

\u2022 Optional status: PodDisruptionBudgetStatus

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/apis/policy/v1beta1/poddisruptionbudgets\"

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"PodDisruptionBudget\"

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getcurrenthealthy","title":"getCurrentHealthy","text":"

\u25b8 getCurrentHealthy(): number

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getdesiredhealthy","title":"getDesiredHealthy","text":"

\u25b8 getDesiredHealthy(): number

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_18","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getmaxunavailable","title":"getMaxUnavailable","text":"

\u25b8 getMaxUnavailable(): string | number

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_19","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getminavailable","title":"getMinAvailable","text":"

\u25b8 getMinAvailable(): string | number

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_20","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_21","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_23","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_24","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_25","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_26","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getselectors","title":"getSelectors","text":"

\u25b8 getSelectors(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_27","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_28","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_29","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_30","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_14","title":"Parameters","text":"Name Type data Partial<PodDisruptionBudget>"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_31","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/","title":"Main.K8sApi.PriorityClass","text":"

@k8slens/extensions / Exports / Main / K8sApi / PriorityClass

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#class-priorityclass","title":"Class: PriorityClass","text":"

Main.K8sApi.PriorityClass

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<ClusterScopedMetadata, void, void>

\u21b3 PriorityClass

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#properties","title":"Properties","text":"
  • apiVersion
  • description
  • globalDefault
  • kind
  • metadata
  • preemptionPolicy
  • spec
  • status
  • value
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getDescription
  • getFinalizers
  • getGlobalDefault
  • getId
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getPreemptionPolicy
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getTimeDiffFromNow
  • getValue
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#constructor","title":"constructor","text":"

\u2022 new PriorityClass(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb PriorityClassData"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#overrides","title":"Overrides","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#description","title":"description","text":"

\u2022 Optional description: string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#globaldefault","title":"globalDefault","text":"

\u2022 Optional globalDefault: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_1","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#metadata","title":"metadata","text":"

\u2022 metadata: ClusterScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_2","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#preemptionpolicy","title":"preemptionPolicy","text":"

\u2022 Optional preemptionPolicy: PreemptionPolicy

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#spec","title":"spec","text":"

\u2022 spec: void

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_3","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#status","title":"status","text":"

\u2022 Optional status: void

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_4","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#value","title":"value","text":"

\u2022 Optional value: number

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/apis/scheduling.k8s.io/v1/priorityclasses\"

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#overrides_1","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_5","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_6","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"PriorityClass\"

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#overrides_2","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: false

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#overrides_3","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_13","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_14","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_15","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_16","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getdescription","title":"getDescription","text":"

\u25b8 getDescription(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_14","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_15","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getglobaldefault","title":"getGlobalDefault","text":"

\u25b8 getGlobalDefault(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_16","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_18","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getns","title":"getNs","text":"

\u25b8 getNs(): undefined

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_20","title":"Returns","text":"

undefined

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_21","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getpreemptionpolicy","title":"getPreemptionPolicy","text":"

\u25b8 getPreemptionPolicy(): PreemptionPolicy

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_22","title":"Returns","text":"

PreemptionPolicy

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_24","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): (undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_25","title":"Returns","text":"

(undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_26","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getvalue","title":"getValue","text":"

\u25b8 getValue(): undefined | number

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_27","title":"Returns","text":"

undefined | number

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_28","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_29","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_29","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_30","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_14","title":"Parameters","text":"Name Type data Partial<PriorityClass>"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_30","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_31","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/","title":"Main.K8sApi.ReplicaSet","text":"

@k8slens/extensions / Exports / Main / K8sApi / ReplicaSet

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#class-replicaset","title":"Class: ReplicaSet","text":"

Main.K8sApi.ReplicaSet

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, ReplicaSetStatus, ReplicaSetSpec>

\u21b3 ReplicaSet

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#methods","title":"Methods","text":"
  • delete
  • getAffinity
  • getAffinityNumber
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getCurrent
  • getDesired
  • getFinalizers
  • getId
  • getImages
  • getLabels
  • getName
  • getNodeSelectors
  • getNs
  • getOwnerRefs
  • getReady
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getSelectors
  • getTemplateLabels
  • getTimeDiffFromNow
  • getTolerations
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#constructor","title":"constructor","text":"

\u2022 new ReplicaSet(data)

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, ReplicaSetStatus, ReplicaSetSpec>"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#spec","title":"spec","text":"

\u2022 spec: ReplicaSetSpec

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#status","title":"status","text":"

\u2022 Optional status: ReplicaSetStatus

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#apibase","title":"apiBase","text":"

\u25aa Static apiBase: string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#kind_1","title":"kind","text":"

\u25aa Static kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#namespaced","title":"namespaced","text":"

\u25aa Static namespaced: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getaffinity","title":"getAffinity","text":"

\u25b8 getAffinity(): undefined | Affinity

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_11","title":"Returns","text":"

undefined | Affinity

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getaffinitynumber","title":"getAffinityNumber","text":"

\u25b8 getAffinityNumber(): number

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_12","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_13","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getcurrent","title":"getCurrent","text":"

\u25b8 getCurrent(): number

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getdesired","title":"getDesired","text":"

\u25b8 getDesired(): number

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_17","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_18","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getimages","title":"getImages","text":"

\u25b8 getImages(): (undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_20","title":"Returns","text":"

(undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_21","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getnodeselectors","title":"getNodeSelectors","text":"

\u25b8 getNodeSelectors(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_23","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_24","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_25","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getready","title":"getReady","text":"

\u25b8 getReady(): number

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_26","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_27","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_28","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_29","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getselectors","title":"getSelectors","text":"

\u25b8 getSelectors(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_30","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#gettemplatelabels","title":"getTemplateLabels","text":"

\u25b8 getTemplateLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_31","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_32","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#gettolerations","title":"getTolerations","text":"

\u25b8 getTolerations(): Toleration[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_33","title":"Returns","text":"

Toleration[]

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_34","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_35","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_14","title":"Parameters","text":"Name Type data Partial<ReplicaSet>"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_36","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/","title":"Main.K8sApi.ResourceQuota","text":"

@k8slens/extensions / Exports / Main / K8sApi / ResourceQuota

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#class-resourcequota","title":"Class: ResourceQuota","text":"

Main.K8sApi.ResourceQuota

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, ResourceQuotaStatus, ResourceQuotaSpec>

\u21b3 ResourceQuota

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getScopeSelector
  • getScopedName
  • getSearchFields
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#constructor","title":"constructor","text":"

\u2022 new ResourceQuota(data)

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, ResourceQuotaStatus, ResourceQuotaSpec>"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#spec","title":"spec","text":"

\u2022 spec: ResourceQuotaSpec

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#status","title":"status","text":"

\u2022 Optional status: ResourceQuotaStatus

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/api/v1/resourcequotas\"

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"ResourceQuota\"

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_18","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_19","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getscopeselector","title":"getScopeSelector","text":"

\u25b8 getScopeSelector(): { operator: string ; scopeName: string ; values: string[] }[]

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_21","title":"Returns","text":"

{ operator: string ; scopeName: string ; values: string[] }[]

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_23","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_24","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_25","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_26","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_14","title":"Parameters","text":"Name Type data Partial<ResourceQuota>"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_27","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/","title":"Main.K8sApi.ResourceStack","text":"

@k8slens/extensions / Exports / Main / K8sApi / ResourceStack

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#class-resourcestack","title":"Class: ResourceStack","text":"

Main.K8sApi.ResourceStack

Deprecated

Switch to using Common.createResourceStack instead

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#implements","title":"Implements","text":"
  • ResourceApplyingStack
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#methods","title":"Methods","text":"
  • kubectlApplyFolder
  • kubectlDeleteFolder
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#constructor","title":"constructor","text":"

\u2022 new ResourceStack(cluster, name)

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#parameters","title":"Parameters","text":"Name Type cluster KubernetesCluster<KubernetesClusterMetadata, KubernetesClusterStatus, KubernetesClusterSpec> name string"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#kubectlapplyfolder","title":"kubectlApplyFolder","text":"

\u25b8 kubectlApplyFolder(folderPath, templateContext?, extraArgs?): Promise<string>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#parameters_1","title":"Parameters","text":"Name Type folderPath string templateContext? any extraArgs? string[]"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#returns","title":"Returns","text":"

Promise<string>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#implementation-of","title":"Implementation of","text":"

ResourceApplyingStack.kubectlApplyFolder

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#kubectldeletefolder","title":"kubectlDeleteFolder","text":"

\u25b8 kubectlDeleteFolder(folderPath, templateContext?, extraArgs?): Promise<string>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#parameters_2","title":"Parameters","text":"Name Type folderPath string templateContext? any extraArgs? string[]"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#returns_1","title":"Returns","text":"

Promise<string>

"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#implementation-of_1","title":"Implementation of","text":"

ResourceApplyingStack.kubectlDeleteFolder

"},{"location":"extensions/api/classes/Main.K8sApi.Role/","title":"Main.K8sApi.Role","text":"

@k8slens/extensions / Exports / Main / K8sApi / Role

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#class-role","title":"Class: Role","text":"

Main.K8sApi.Role

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, void, void>

\u21b3 Role

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.Role/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • rules
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getRules
  • getScopedName
  • getSearchFields
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Role/#constructor","title":"constructor","text":"

\u2022 new Role(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb RoleData"},{"location":"extensions/api/classes/Main.K8sApi.Role/#overrides","title":"Overrides","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Role/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_1","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_2","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#rules","title":"rules","text":"

\u2022 Optional rules: PolicyRule[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#spec","title":"spec","text":"

\u2022 spec: void

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_3","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#status","title":"status","text":"

\u2022 Optional status: void

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_4","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/apis/rbac.authorization.k8s.io/v1/roles\"

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#overrides_1","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_5","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_6","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Role/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"Role\"

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#overrides_2","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#overrides_3","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_13","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Role/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_14","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Role/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_15","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_16","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_18","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_19","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getrules","title":"getRules","text":"

\u25b8 getRules(): PolicyRule[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_21","title":"Returns","text":"

PolicyRule[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_23","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_24","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_25","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_29","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_26","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_30","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_14","title":"Parameters","text":"Name Type data Partial<Role>"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_27","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_31","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/","title":"Main.K8sApi.RoleBinding","text":"

@k8slens/extensions / Exports / Main / K8sApi / RoleBinding

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#class-rolebinding","title":"Class: RoleBinding","text":"

Main.K8sApi.RoleBinding

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, void, void>

\u21b3 RoleBinding

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • roleRef
  • spec
  • status
  • subjects
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getSubjectNames
  • getSubjects
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#constructor","title":"constructor","text":"

\u2022 new RoleBinding(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb RoleBindingData"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#overrides","title":"Overrides","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_1","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_2","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#roleref","title":"roleRef","text":"

\u2022 roleRef: RoleRef

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#spec","title":"spec","text":"

\u2022 spec: void

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_3","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#status","title":"status","text":"

\u2022 Optional status: void

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_4","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#subjects","title":"subjects","text":"

\u2022 Optional subjects: Subject[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/apis/rbac.authorization.k8s.io/v1/rolebindings\"

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#overrides_1","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_5","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_6","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"RoleBinding\"

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#overrides_2","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#overrides_3","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_13","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_14","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_15","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_16","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_18","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_19","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_21","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_22","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getsubjectnames","title":"getSubjectNames","text":"

\u25b8 getSubjectNames(): string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getsubjects","title":"getSubjects","text":"

\u25b8 getSubjects(): Subject[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_24","title":"Returns","text":"

Subject[]

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_25","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_26","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_29","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_27","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_30","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_14","title":"Parameters","text":"Name Type data Partial<RoleBinding>"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_28","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_31","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/","title":"Main.K8sApi.Secret","text":"

@k8slens/extensions / Exports / Main / K8sApi / Secret

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#class-secret","title":"Class: Secret","text":"

Main.K8sApi.Secret

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, void, void>

\u21b3 Secret

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.Secret/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#properties","title":"Properties","text":"
  • apiVersion
  • data
  • kind
  • metadata
  • spec
  • status
  • type
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getKeys
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getTimeDiffFromNow
  • getToken
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Secret/#constructor","title":"constructor","text":"

\u2022 new Secret(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb SecretData"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#overrides","title":"Overrides","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Secret/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#data","title":"data","text":"

\u2022 data: Partial<Record<string, string>>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_1","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_2","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#spec","title":"spec","text":"

\u2022 spec: void

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_3","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#status","title":"status","text":"

\u2022 Optional status: void

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_4","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type","title":"type","text":"

\u2022 type: SecretType

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/api/v1/secrets\"

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#overrides_1","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_5","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_6","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"Secret\"

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#overrides_2","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#overrides_3","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_13","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Secret/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_14","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Secret/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_15","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_16","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getkeys","title":"getKeys","text":"

\u25b8 getKeys(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_17","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_18","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_20","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_21","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_23","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_24","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#gettoken","title":"getToken","text":"

\u25b8 getToken(): undefined | string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_25","title":"Returns","text":"

undefined | string

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_26","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_29","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_27","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_30","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_14","title":"Parameters","text":"Name Type data Partial<Secret>"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_28","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_31","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.Service/","title":"Main.K8sApi.Service","text":"

@k8slens/extensions / Exports / Main / K8sApi / Service

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#class-service","title":"Class: Service","text":"

Main.K8sApi.Service

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, ServiceStatus, ServiceSpec>

\u21b3 Service

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.Service/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getClusterIp
  • getClusterIps
  • getCreationTimestamp
  • getExternalIps
  • getFinalizers
  • getId
  • getIpFamilies
  • getIpFamilyPolicy
  • getLabels
  • getLoadBalancer
  • getName
  • getNs
  • getOwnerRefs
  • getPorts
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getSelector
  • getStatus
  • getTimeDiffFromNow
  • getType
  • isActive
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Service/#constructor","title":"constructor","text":"

\u2022 new Service(data)

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, ServiceStatus, ServiceSpec>"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Service/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#spec","title":"spec","text":"

\u2022 spec: ServiceSpec

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#status","title":"status","text":"

\u2022 Optional status: ServiceStatus

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/api/v1/services\"

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Service/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"Service\"

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Service/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Service/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getclusterip","title":"getClusterIp","text":"

\u25b8 getClusterIp(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_13","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getclusterips","title":"getClusterIps","text":"

\u25b8 getClusterIps(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getexternalips","title":"getExternalIps","text":"

\u25b8 getExternalIps(): (undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_16","title":"Returns","text":"

(undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_17","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_18","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getipfamilies","title":"getIpFamilies","text":"

\u25b8 getIpFamilies(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_19","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getipfamilypolicy","title":"getIpFamilyPolicy","text":"

\u25b8 getIpFamilyPolicy(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_21","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getloadbalancer","title":"getLoadBalancer","text":"

\u25b8 getLoadBalancer(): undefined | { ingress?: { hostname?: string ; ip?: string }[] }

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_22","title":"Returns","text":"

undefined | { ingress?: { hostname?: string ; ip?: string }[] }

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_23","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_24","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_25","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getports","title":"getPorts","text":"

\u25b8 getPorts(): ServicePort[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_26","title":"Returns","text":"

ServicePort[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_27","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_28","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_29","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getselector","title":"getSelector","text":"

\u25b8 getSelector(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_30","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getstatus","title":"getStatus","text":"

\u25b8 getStatus(): \"Active\" | \"Pending\"

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_31","title":"Returns","text":"

\"Active\" | \"Pending\"

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_32","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#gettype","title":"getType","text":"

\u25b8 getType(): string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_33","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#isactive","title":"isActive","text":"

\u25b8 isActive(): boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_34","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_35","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_36","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_14","title":"Parameters","text":"Name Type data Partial<Service>"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_37","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/","title":"Main.K8sApi.ServiceAccount","text":"

@k8slens/extensions / Exports / Main / K8sApi / ServiceAccount

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#class-serviceaccount","title":"Class: ServiceAccount","text":"

Main.K8sApi.ServiceAccount

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, void, void>

\u21b3 ServiceAccount

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#properties","title":"Properties","text":"
  • apiVersion
  • automountServiceAccountToken
  • imagePullSecrets
  • kind
  • metadata
  • secrets
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getImagePullSecrets
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getSecrets
  • getTimeDiffFromNow
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#constructor","title":"constructor","text":"

\u2022 new ServiceAccount(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb ServiceAccountData"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#overrides","title":"Overrides","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#automountserviceaccounttoken","title":"automountServiceAccountToken","text":"

\u2022 Optional automountServiceAccountToken: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#imagepullsecrets","title":"imagePullSecrets","text":"

\u2022 Optional imagePullSecrets: LocalObjectReference[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_1","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_2","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#secrets","title":"secrets","text":"

\u2022 Optional secrets: ObjectReference[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#spec","title":"spec","text":"

\u2022 spec: void

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_3","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#status","title":"status","text":"

\u2022 Optional status: void

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_4","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/api/v1/serviceaccounts\"

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#overrides_1","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_5","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_6","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"ServiceAccount\"

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#overrides_2","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#overrides_3","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_13","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_14","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_15","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_16","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getimagepullsecrets","title":"getImagePullSecrets","text":"

\u25b8 getImagePullSecrets(): LocalObjectReference[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_16","title":"Returns","text":"

LocalObjectReference[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_17","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_18","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_19","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_20","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_21","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_23","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getsecrets","title":"getSecrets","text":"

\u25b8 getSecrets(): ObjectReference[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_24","title":"Returns","text":"

ObjectReference[]

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_25","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_26","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_29","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_27","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_30","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_14","title":"Parameters","text":"Name Type data Partial<ServiceAccount>"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_28","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_31","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/","title":"Main.K8sApi.StatefulSet","text":"

@k8slens/extensions / Exports / Main / K8sApi / StatefulSet

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#class-statefulset","title":"Class: StatefulSet","text":"

Main.K8sApi.StatefulSet

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<NamespaceScopedMetadata, StatefulSetStatus, StatefulSetSpec>

\u21b3 StatefulSet

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#methods","title":"Methods","text":"
  • delete
  • getAffinity
  • getAffinityNumber
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getImages
  • getLabels
  • getName
  • getNodeSelectors
  • getNs
  • getOwnerRefs
  • getReplicas
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getSelectors
  • getTemplateLabels
  • getTimeDiffFromNow
  • getTolerations
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#constructor","title":"constructor","text":"

\u2022 new StatefulSet(data)

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<NamespaceScopedMetadata, StatefulSetStatus, StatefulSetSpec>"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from","title":"Inherited from","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_1","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_2","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#metadata","title":"metadata","text":"

\u2022 metadata: NamespaceScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_3","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#spec","title":"spec","text":"

\u2022 spec: StatefulSetSpec

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_4","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#status","title":"status","text":"

\u2022 Optional status: StatefulSetStatus

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_5","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/apis/apps/v1/statefulsets\"

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#overrides","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_6","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_2","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_4","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_6","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_7","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_13","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"StatefulSet\"

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#overrides_1","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: true

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#overrides_2","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_9","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_14","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_15","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_10","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_16","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getaffinity","title":"getAffinity","text":"

\u25b8 getAffinity(): Affinity

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_11","title":"Returns","text":"

Affinity

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getaffinitynumber","title":"getAffinityNumber","text":"

\u25b8 getAffinityNumber(): number

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_12","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_11","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_13","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_12","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getimages","title":"getImages","text":"

\u25b8 getImages(): (undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_18","title":"Returns","text":"

(undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_19","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getnodeselectors","title":"getNodeSelectors","text":"

\u25b8 getNodeSelectors(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_21","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getns","title":"getNs","text":"

\u25b8 getNs(): string

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_23","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getreplicas","title":"getReplicas","text":"

\u25b8 getReplicas(): number

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_24","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_25","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_26","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_27","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getselectors","title":"getSelectors","text":"

\u25b8 getSelectors(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_28","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#gettemplatelabels","title":"getTemplateLabels","text":"

\u25b8 getTemplateLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_29","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_30","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_29","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#gettolerations","title":"getTolerations","text":"

\u25b8 getTolerations(): Toleration[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_31","title":"Returns","text":"

Toleration[]

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_13","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_32","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_30","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_33","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_31","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_14","title":"Parameters","text":"Name Type data Partial<StatefulSet>"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_34","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_32","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/","title":"Main.K8sApi.StorageClass","text":"

@k8slens/extensions / Exports / Main / K8sApi / StorageClass

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#class-storageclass","title":"Class: StorageClass","text":"

Main.K8sApi.StorageClass

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#hierarchy","title":"Hierarchy","text":"
  • KubeObject<ClusterScopedMetadata, void, void>

\u21b3 StorageClass

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#properties","title":"Properties","text":"
  • allowVolumeExpansion
  • allowedTopologies
  • apiVersion
  • kind
  • metadata
  • mountOptions
  • parameters
  • provisioner
  • reclaimPolicy
  • spec
  • status
  • volumeBindingMode
  • apiBase
  • create
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • kind
  • namespaced
  • stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#accessors","title":"Accessors","text":"
  • selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#methods","title":"Methods","text":"
  • delete
  • getAge
  • getAnnotations
  • getCreationTimestamp
  • getFinalizers
  • getId
  • getLabels
  • getName
  • getNs
  • getOwnerRefs
  • getReclaimPolicy
  • getResourceVersion
  • getScopedName
  • getSearchFields
  • getTimeDiffFromNow
  • getVolumeBindingMode
  • isDefault
  • patch
  • toPlainObject
  • update
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#constructor","title":"constructor","text":"

\u2022 new StorageClass(\u00abdestructured\u00bb)

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb StorageClassData"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#overrides","title":"Overrides","text":"

KubeObject.constructor

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#allowvolumeexpansion","title":"allowVolumeExpansion","text":"

\u2022 Optional allowVolumeExpansion: boolean

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#allowedtopologies","title":"allowedTopologies","text":"

\u2022 allowedTopologies: TopologySelectorTerm[]

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from","title":"Inherited from","text":"

KubeObject.apiVersion

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_1","title":"Inherited from","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#metadata","title":"metadata","text":"

\u2022 metadata: ClusterScopedMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_2","title":"Inherited from","text":"

KubeObject.metadata

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#mountoptions","title":"mountOptions","text":"

\u2022 mountOptions: string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_1","title":"parameters","text":"

\u2022 parameters: Partial<Record<string, string>>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#provisioner","title":"provisioner","text":"

\u2022 provisioner: string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#reclaimpolicy","title":"reclaimPolicy","text":"

\u2022 reclaimPolicy: string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#spec","title":"spec","text":"

\u2022 spec: void

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_3","title":"Inherited from","text":"

KubeObject.spec

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#status","title":"status","text":"

\u2022 Optional status: void

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_4","title":"Inherited from","text":"

KubeObject.status

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#volumebindingmode","title":"volumeBindingMode","text":"

\u2022 Optional volumeBindingMode: string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#apibase","title":"apiBase","text":"

\u25aa Static Readonly apiBase: \"/apis/storage.k8s.io/v1/storageclasses\"

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#overrides_1","title":"Overrides","text":"

KubeObject.apiBase

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#create","title":"create","text":"

\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#type-declaration","title":"Type declaration","text":"

\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_2","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns","title":"Returns","text":"

KubeObject<Metadata, Status, Spec>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_5","title":"Inherited from","text":"

KubeObject.create

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#isjsonapidata","title":"isJsonApiData","text":"

\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_3","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_1","title":"Returns","text":"

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_6","title":"Inherited from","text":"

KubeObject.isJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#isjsonapidatalist","title":"isJsonApiDataList","text":"

\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#type-declaration_2","title":"Type declaration","text":"

\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#type-parameters_1","title":"Type parameters","text":"Name T"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_4","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_2","title":"Returns","text":"

object is KubeJsonApiDataList<T>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_7","title":"Inherited from","text":"

KubeObject.isJsonApiDataList

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiListMetadata

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_5","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_3","title":"Returns","text":"

object is KubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_8","title":"Inherited from","text":"

KubeObject.isKubeJsonApiListMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_6","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_4","title":"Returns","text":"

object is KubeJsonApiObjectMetadata<KubeObjectScope>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_9","title":"Inherited from","text":"

KubeObject.isKubeJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#isnonsystem","title":"isNonSystem","text":"

\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item): boolean

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_7","title":"Parameters","text":"Name Type item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_5","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_10","title":"Inherited from","text":"

KubeObject.isNonSystem

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_8","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_6","title":"Returns","text":"

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_11","title":"Inherited from","text":"

KubeObject.isPartialJsonApiData

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_9","title":"Parameters","text":"Name Type object unknown"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_7","title":"Returns","text":"

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_12","title":"Inherited from","text":"

KubeObject.isPartialJsonApiMetadata

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#kind_1","title":"kind","text":"

\u25aa Static Readonly kind: \"StorageClass\"

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#overrides_2","title":"Overrides","text":"

KubeObject.kind

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#namespaced","title":"namespaced","text":"

\u25aa Static Readonly namespaced: false

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#overrides_3","title":"Overrides","text":"

KubeObject.namespaced

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#stringifylabels","title":"stringifyLabels","text":"

\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (labels?): string[]

Deprecated

Switch to using __type instead

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_10","title":"Parameters","text":"Name Type labels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_8","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_13","title":"Inherited from","text":"

KubeObject.stringifyLabels

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#selflink","title":"selfLink","text":"

\u2022 get selfLink(): string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_14","title":"Inherited from","text":"

KubeObject.selfLink

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#delete","title":"delete","text":"

\u25b8 delete(params?): void

Deprecated

use KubeApi.delete instead

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_11","title":"Parameters","text":"Name Type params? object"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_15","title":"Inherited from","text":"

KubeObject.delete

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getage","title":"getAge","text":"

\u25b8 getAge(humanize?, compact?, fromNow?): string | number

Deprecated

This function computes a new \"now\" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_12","title":"Parameters","text":"Name Type humanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_11","title":"Returns","text":"

string | number

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_16","title":"Inherited from","text":"

KubeObject.getAge

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getannotations","title":"getAnnotations","text":"

\u25b8 getAnnotations(filter?): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_13","title":"Parameters","text":"Name Type filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_12","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_17","title":"Inherited from","text":"

KubeObject.getAnnotations

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getcreationtimestamp","title":"getCreationTimestamp","text":"

\u25b8 getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_13","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_18","title":"Inherited from","text":"

KubeObject.getCreationTimestamp

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getfinalizers","title":"getFinalizers","text":"

\u25b8 getFinalizers(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_14","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_19","title":"Inherited from","text":"

KubeObject.getFinalizers

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getid","title":"getId","text":"

\u25b8 getId(): string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_15","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_20","title":"Inherited from","text":"

KubeObject.getId

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getlabels","title":"getLabels","text":"

\u25b8 getLabels(): string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_16","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_21","title":"Inherited from","text":"

KubeObject.getLabels

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getname","title":"getName","text":"

\u25b8 getName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_17","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_22","title":"Inherited from","text":"

KubeObject.getName

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getns","title":"getNs","text":"

\u25b8 getNs(): undefined

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_18","title":"Returns","text":"

undefined

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_23","title":"Inherited from","text":"

KubeObject.getNs

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getownerrefs","title":"getOwnerRefs","text":"

\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_19","title":"Returns","text":"

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_24","title":"Inherited from","text":"

KubeObject.getOwnerRefs

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getreclaimpolicy","title":"getReclaimPolicy","text":"

\u25b8 getReclaimPolicy(): string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_20","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getresourceversion","title":"getResourceVersion","text":"

\u25b8 getResourceVersion(): string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_21","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_25","title":"Inherited from","text":"

KubeObject.getResourceVersion

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getscopedname","title":"getScopedName","text":"

\u25b8 getScopedName(): string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_22","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_26","title":"Inherited from","text":"

KubeObject.getScopedName

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getsearchfields","title":"getSearchFields","text":"

\u25b8 getSearchFields(): (undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_23","title":"Returns","text":"

(undefined | string)[]

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_27","title":"Inherited from","text":"

KubeObject.getSearchFields

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"

\u25b8 getTimeDiffFromNow(): number

Deprecated

This function computes a new \"now\". Switch to using getCreationTimestamp instead

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_24","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_28","title":"Inherited from","text":"

KubeObject.getTimeDiffFromNow

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getvolumebindingmode","title":"getVolumeBindingMode","text":"

\u25b8 getVolumeBindingMode(): string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_25","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#isdefault","title":"isDefault","text":"

\u25b8 isDefault(): boolean

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_26","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#patch","title":"patch","text":"

\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_14","title":"Parameters","text":"Name Type patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_27","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_29","title":"Inherited from","text":"

KubeObject.patch

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#toplainobject","title":"toPlainObject","text":"

\u25b8 toPlainObject(): Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_28","title":"Returns","text":"

Record<string, unknown>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_30","title":"Inherited from","text":"

KubeObject.toPlainObject

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#update","title":"update","text":"

\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_15","title":"Parameters","text":"Name Type data Partial<StorageClass>"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_29","title":"Returns","text":"

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_31","title":"Inherited from","text":"

KubeObject.update

"},{"location":"extensions/api/classes/Main.LensExtension/","title":"Main.LensExtension","text":"

@k8slens/extensions / Exports / Main / LensExtension

"},{"location":"extensions/api/classes/Main.LensExtension/#class-lensextension","title":"Class: LensExtension","text":"

Main.LensExtension

"},{"location":"extensions/api/classes/Main.LensExtension/#hierarchy","title":"Hierarchy","text":"
  • LensExtension

\u21b3 LensExtension

"},{"location":"extensions/api/classes/Main.LensExtension/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.LensExtension/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Main.LensExtension/#properties","title":"Properties","text":"
  • appMenus
  • id
  • isBundled
  • manifest
  • manifestPath
  • protocolHandlers
  • terminalShellEnvModifier
  • trayMenus
"},{"location":"extensions/api/classes/Main.LensExtension/#accessors","title":"Accessors","text":"
  • description
  • isEnabled
  • name
  • sanitizedExtensionId
  • storeName
  • version
"},{"location":"extensions/api/classes/Main.LensExtension/#methods","title":"Methods","text":"
  • activate
  • addCatalogSource
  • disable
  • enable
  • getExtensionFileFolder
  • navigate
  • onActivate
  • onDeactivate
  • removeCatalogSource
"},{"location":"extensions/api/classes/Main.LensExtension/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Main.LensExtension/#constructor","title":"constructor","text":"

\u2022 new LensExtension(extension)

"},{"location":"extensions/api/classes/Main.LensExtension/#parameters","title":"Parameters","text":"Name Type extension InstalledExtension"},{"location":"extensions/api/classes/Main.LensExtension/#overrides","title":"Overrides","text":"

LensExtension.constructor

"},{"location":"extensions/api/classes/Main.LensExtension/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.LensExtension/#appmenus","title":"appMenus","text":"

\u2022 appMenus: MenuRegistration[] | IComputedValue<MenuRegistration[]>

"},{"location":"extensions/api/classes/Main.LensExtension/#id","title":"id","text":"

\u2022 Readonly id: string

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from","title":"Inherited from","text":"

LensExtension.id

"},{"location":"extensions/api/classes/Main.LensExtension/#isbundled","title":"isBundled","text":"

\u2022 Readonly isBundled: boolean

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_1","title":"Inherited from","text":"

LensExtension.isBundled

"},{"location":"extensions/api/classes/Main.LensExtension/#manifest","title":"manifest","text":"

\u2022 Readonly manifest: LensExtensionManifest

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_2","title":"Inherited from","text":"

LensExtension.manifest

"},{"location":"extensions/api/classes/Main.LensExtension/#manifestpath","title":"manifestPath","text":"

\u2022 Readonly manifestPath: string

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_3","title":"Inherited from","text":"

LensExtension.manifestPath

"},{"location":"extensions/api/classes/Main.LensExtension/#protocolhandlers","title":"protocolHandlers","text":"

\u2022 protocolHandlers: ProtocolHandlerRegistration[]

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_4","title":"Inherited from","text":"

LensExtension.protocolHandlers

"},{"location":"extensions/api/classes/Main.LensExtension/#terminalshellenvmodifier","title":"terminalShellEnvModifier","text":"

\u2022 Optional terminalShellEnvModifier: ShellEnvModifier

implement this to modify the shell environment that Lens terminals are opened with. The ShellEnvModifier type has the signature

(ctx: ShellEnvContext, env: Record) => Record

Param

the shell environment context, specifically the relevant catalog entity for the terminal. This can be used, for example, to get cluster-specific information that can be made available in the shell environment by the implementation of terminalShellEnvModifier

Param

the current shell environment that the terminal will be opened with. The implementation should modify this as desired.

"},{"location":"extensions/api/classes/Main.LensExtension/#traymenus","title":"trayMenus","text":"

\u2022 trayMenus: TrayMenuRegistration[] | IComputedValue<TrayMenuRegistration[]>

"},{"location":"extensions/api/classes/Main.LensExtension/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.LensExtension/#description","title":"description","text":"

\u2022 get description(): undefined | string

"},{"location":"extensions/api/classes/Main.LensExtension/#returns","title":"Returns","text":"

undefined | string

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_5","title":"Inherited from","text":"

LensExtension.description

"},{"location":"extensions/api/classes/Main.LensExtension/#isenabled","title":"isEnabled","text":"

\u2022 get isEnabled(): boolean

"},{"location":"extensions/api/classes/Main.LensExtension/#returns_1","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_6","title":"Inherited from","text":"

LensExtension.isEnabled

"},{"location":"extensions/api/classes/Main.LensExtension/#name","title":"name","text":"

\u2022 get name(): string

"},{"location":"extensions/api/classes/Main.LensExtension/#returns_2","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_7","title":"Inherited from","text":"

LensExtension.name

"},{"location":"extensions/api/classes/Main.LensExtension/#sanitizedextensionid","title":"sanitizedExtensionId","text":"

\u2022 get sanitizedExtensionId(): string

"},{"location":"extensions/api/classes/Main.LensExtension/#returns_3","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_8","title":"Inherited from","text":"

LensExtension.sanitizedExtensionId

"},{"location":"extensions/api/classes/Main.LensExtension/#storename","title":"storeName","text":"

\u2022 get storeName(): string

"},{"location":"extensions/api/classes/Main.LensExtension/#returns_4","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_9","title":"Inherited from","text":"

LensExtension.storeName

"},{"location":"extensions/api/classes/Main.LensExtension/#version","title":"version","text":"

\u2022 get version(): string

"},{"location":"extensions/api/classes/Main.LensExtension/#returns_5","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_10","title":"Inherited from","text":"

LensExtension.version

"},{"location":"extensions/api/classes/Main.LensExtension/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.LensExtension/#activate","title":"activate","text":"

\u25b8 activate(): Promise<void>

"},{"location":"extensions/api/classes/Main.LensExtension/#returns_6","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_11","title":"Inherited from","text":"

LensExtension.activate

"},{"location":"extensions/api/classes/Main.LensExtension/#addcatalogsource","title":"addCatalogSource","text":"

\u25b8 addCatalogSource(id, source): void

"},{"location":"extensions/api/classes/Main.LensExtension/#parameters_1","title":"Parameters","text":"Name Type id string source IObservableArray<CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>> | IComputedValue<CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>[]>"},{"location":"extensions/api/classes/Main.LensExtension/#returns_7","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Main.LensExtension/#disable","title":"disable","text":"

\u25b8 disable(): Promise<void>

"},{"location":"extensions/api/classes/Main.LensExtension/#returns_8","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_12","title":"Inherited from","text":"

LensExtension.disable

"},{"location":"extensions/api/classes/Main.LensExtension/#enable","title":"enable","text":"

\u25b8 enable(): Promise<void>

"},{"location":"extensions/api/classes/Main.LensExtension/#returns_9","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_13","title":"Inherited from","text":"

LensExtension.enable

"},{"location":"extensions/api/classes/Main.LensExtension/#getextensionfilefolder","title":"getExtensionFileFolder","text":"

\u25b8 getExtensionFileFolder(): Promise<string>

getExtensionFileFolder returns the path to an already created folder. This folder is for the sole use of this extension.

Note: there is no security done on this folder, only obfuscation of the folder name.

"},{"location":"extensions/api/classes/Main.LensExtension/#returns_10","title":"Returns","text":"

Promise<string>

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_14","title":"Inherited from","text":"

LensExtension.getExtensionFileFolder

"},{"location":"extensions/api/classes/Main.LensExtension/#navigate","title":"navigate","text":"

\u25b8 navigate(pageId?, params?, frameId?): Promise<void>

"},{"location":"extensions/api/classes/Main.LensExtension/#parameters_2","title":"Parameters","text":"Name Type pageId? string params? Record<string, any> frameId? number"},{"location":"extensions/api/classes/Main.LensExtension/#returns_11","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Main.LensExtension/#onactivate","title":"onActivate","text":"

\u25b8 Protected onActivate(): void | Promise<void>

"},{"location":"extensions/api/classes/Main.LensExtension/#returns_12","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_15","title":"Inherited from","text":"

LensExtension.onActivate

"},{"location":"extensions/api/classes/Main.LensExtension/#ondeactivate","title":"onDeactivate","text":"

\u25b8 Protected onDeactivate(): void | Promise<void>

"},{"location":"extensions/api/classes/Main.LensExtension/#returns_13","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/classes/Main.LensExtension/#inherited-from_16","title":"Inherited from","text":"

LensExtension.onDeactivate

"},{"location":"extensions/api/classes/Main.LensExtension/#removecatalogsource","title":"removeCatalogSource","text":"

\u25b8 removeCatalogSource(id): void

"},{"location":"extensions/api/classes/Main.LensExtension/#parameters_3","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Main.LensExtension/#returns_14","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/","title":"Renderer.Catalog.CatalogEntityRegistry","text":"

@k8slens/extensions / Exports / Renderer / Catalog / CatalogEntityRegistry

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#class-catalogentityregistry","title":"Class: CatalogEntityRegistry","text":"

Renderer.Catalog.CatalogEntityRegistry

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#accessors","title":"Accessors","text":"
  • activeEntity
  • entities
"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#methods","title":"Methods","text":"
  • addOnBeforeRun
  • getById
  • getItemsForApiKind
  • getItemsForCategory
"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#constructor","title":"constructor","text":"

\u2022 new CatalogEntityRegistry()

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#activeentity","title":"activeEntity","text":"

\u2022 get activeEntity(): undefined | CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>

Currently active/visible entity

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#returns","title":"Returns","text":"

undefined | CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#entities","title":"entities","text":"

\u2022 get entities(): Map<string, CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>>

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#returns_1","title":"Returns","text":"

Map<string, CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>>

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#addonbeforerun","title":"addOnBeforeRun","text":"

\u25b8 addOnBeforeRun(onBeforeRun): Disposer

Add a onBeforeRun hook to a catalog entities. If onBeforeRun was previously added then it will not be added again.

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#parameters","title":"Parameters","text":"Name Type Description onBeforeRun CatalogEntityOnBeforeRun The function to be called with a CatalogRunEvent event target will be the catalog entity. onBeforeRun hook can call event.preventDefault() to stop run sequence"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#returns_2","title":"Returns","text":"

Disposer

A function to remove that hook

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#parameters_1","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#returns_3","title":"Returns","text":"

undefined | CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#getitemsforapikind","title":"getItemsForApiKind","text":"

\u25b8 getItemsForApiKind<T>(apiVersion, kind): T[]

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#type-parameters","title":"Type parameters","text":"Name Type T extends CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec, T>"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#parameters_2","title":"Parameters","text":"Name Type apiVersion string kind string"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#returns_4","title":"Returns","text":"

T[]

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#getitemsforcategory","title":"getItemsForCategory","text":"

\u25b8 getItemsForCategory<T>(category): T[]

"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#type-parameters_1","title":"Type parameters","text":"Name Type T extends CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec, T>"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#parameters_3","title":"Parameters","text":"Name Type category CatalogCategory"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#returns_5","title":"Returns","text":"

T[]

"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/","title":"Renderer.Component.DrawerParamToggler","text":"

@k8slens/extensions / Exports / Renderer / Component / DrawerParamToggler

"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#class-drawerparamtoggler","title":"Class: DrawerParamToggler","text":"

Renderer.Component.DrawerParamToggler

"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#hierarchy","title":"Hierarchy","text":"
  • Component<DrawerParamTogglerProps, State>

\u21b3 DrawerParamToggler

"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#properties","title":"Properties","text":"
  • state
  • toggle
"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#methods","title":"Methods","text":"
  • render
"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#constructor","title":"constructor","text":"

\u2022 new DrawerParamToggler(props)

"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#parameters","title":"Parameters","text":"Name Type props DrawerParamTogglerProps | Readonly<DrawerParamTogglerProps>"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#inherited-from","title":"Inherited from","text":"

React.Component<DrawerParamTogglerProps, State>.constructor

\u2022 new DrawerParamToggler(props, context)

Deprecated

See

https://legacy.reactjs.org/docs/legacy-context.html

"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#parameters_1","title":"Parameters","text":"Name Type props DrawerParamTogglerProps context any"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#inherited-from_1","title":"Inherited from","text":"

React.Component<DrawerParamTogglerProps, State>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#state","title":"state","text":"

\u2022 state: State

"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#overrides","title":"Overrides","text":"

React.Component.state

"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#toggle","title":"toggle","text":"

\u2022 toggle: () => void

"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#type-declaration","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#returns_1","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#overrides_1","title":"Overrides","text":"

React.Component.render

"},{"location":"extensions/api/classes/Renderer.Component.Input/","title":"Renderer.Component.Input","text":"

@k8slens/extensions / Exports / Renderer / Component / Input

"},{"location":"extensions/api/classes/Renderer.Component.Input/#class-input","title":"Class: Input","text":"

Renderer.Component.Input

"},{"location":"extensions/api/classes/Renderer.Component.Input/#hierarchy","title":"Hierarchy","text":"
  • Component<InputProps, State>

\u21b3 Input

"},{"location":"extensions/api/classes/Renderer.Component.Input/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.Input/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.Input/#properties","title":"Properties","text":"
  • input
  • setDirtyOnChange
  • state
  • validators
  • defaultProps
"},{"location":"extensions/api/classes/Renderer.Component.Input/#accessors","title":"Accessors","text":"
  • isUncontrolled
  • showMaxLenIndicator
  • themeSelection
"},{"location":"extensions/api/classes/Renderer.Component.Input/#methods","title":"Methods","text":"
  • bindRef
  • blur
  • componentDidMount
  • componentDidUpdate
  • componentWillUnmount
  • focus
  • getValue
  • onBlur
  • onChange
  • onFocus
  • onKeyDown
  • render
  • select
  • setDirty
  • setValidation
  • setValue
  • validate
"},{"location":"extensions/api/classes/Renderer.Component.Input/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.Input/#constructor","title":"constructor","text":"

\u2022 new Input(props)

"},{"location":"extensions/api/classes/Renderer.Component.Input/#parameters","title":"Parameters","text":"Name Type props InputProps"},{"location":"extensions/api/classes/Renderer.Component.Input/#overrides","title":"Overrides","text":"

React.Component<InputProps, State\\>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.Input/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.Input/#input","title":"input","text":"

\u2022 input: null | InputElement

"},{"location":"extensions/api/classes/Renderer.Component.Input/#setdirtyonchange","title":"setDirtyOnChange","text":"

\u2022 setDirtyOnChange: DebouncedFunc<() => void>

"},{"location":"extensions/api/classes/Renderer.Component.Input/#state","title":"state","text":"

\u2022 state: State

"},{"location":"extensions/api/classes/Renderer.Component.Input/#overrides_1","title":"Overrides","text":"

React.Component.state

"},{"location":"extensions/api/classes/Renderer.Component.Input/#validators","title":"validators","text":"

\u2022 validators: InputValidator<boolean>[]

"},{"location":"extensions/api/classes/Renderer.Component.Input/#defaultprops","title":"defaultProps","text":"

\u25aa Static defaultProps: object

"},{"location":"extensions/api/classes/Renderer.Component.Input/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.Component.Input/#isuncontrolled","title":"isUncontrolled","text":"

\u2022 get isUncontrolled(): boolean

"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.Component.Input/#showmaxlenindicator","title":"showMaxLenIndicator","text":"

\u2022 get showMaxLenIndicator(): undefined | boolean | 0

"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_1","title":"Returns","text":"

undefined | boolean | 0

"},{"location":"extensions/api/classes/Renderer.Component.Input/#themeselection","title":"themeSelection","text":"

\u2022 get themeSelection(): Record<string, boolean>

"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_2","title":"Returns","text":"

Record<string, boolean>

"},{"location":"extensions/api/classes/Renderer.Component.Input/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.Input/#bindref","title":"bindRef","text":"

\u25b8 bindRef(elem): void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#parameters_1","title":"Parameters","text":"Name Type elem InputElement"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#blur","title":"blur","text":"

\u25b8 blur(): void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_4","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#componentdidmount","title":"componentDidMount","text":"

\u25b8 componentDidMount(): void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#overrides_2","title":"Overrides","text":"

React.Component.componentDidMount

"},{"location":"extensions/api/classes/Renderer.Component.Input/#componentdidupdate","title":"componentDidUpdate","text":"

\u25b8 componentDidUpdate(prevProps): void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#parameters_2","title":"Parameters","text":"Name Type prevProps InputProps"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_6","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#overrides_3","title":"Overrides","text":"

React.Component.componentDidUpdate

"},{"location":"extensions/api/classes/Renderer.Component.Input/#componentwillunmount","title":"componentWillUnmount","text":"

\u25b8 componentWillUnmount(): void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_7","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#overrides_4","title":"Overrides","text":"

React.Component.componentWillUnmount

"},{"location":"extensions/api/classes/Renderer.Component.Input/#focus","title":"focus","text":"

\u25b8 focus(): void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_8","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#getvalue","title":"getValue","text":"

\u25b8 getValue(): string

"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_9","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.Component.Input/#onblur","title":"onBlur","text":"

\u25b8 onBlur(evt): void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#parameters_3","title":"Parameters","text":"Name Type evt FocusEvent<InputElement, Element>"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_10","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#onchange","title":"onChange","text":"

\u25b8 onChange(evt): Promise<void>

"},{"location":"extensions/api/classes/Renderer.Component.Input/#parameters_4","title":"Parameters","text":"Name Type evt ChangeEvent<any>"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_11","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.Component.Input/#onfocus","title":"onFocus","text":"

\u25b8 onFocus(evt): void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#parameters_5","title":"Parameters","text":"Name Type evt FocusEvent<InputElement, Element>"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_12","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#onkeydown","title":"onKeyDown","text":"

\u25b8 onKeyDown(evt): void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#parameters_6","title":"Parameters","text":"Name Type evt KeyboardEvent<InputElement>"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_13","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_14","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.Input/#overrides_5","title":"Overrides","text":"

React.Component.render

"},{"location":"extensions/api/classes/Renderer.Component.Input/#select","title":"select","text":"

\u25b8 select(): void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_15","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#setdirty","title":"setDirty","text":"

\u25b8 setDirty(dirty?): void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#parameters_7","title":"Parameters","text":"Name Type dirty? boolean"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_16","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#setvalidation","title":"setValidation","text":"

\u25b8 setValidation(errors): void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#parameters_8","title":"Parameters","text":"Name Type errors ReactNode[]"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_17","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#setvalue","title":"setValue","text":"

\u25b8 setValue(value?): void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#parameters_9","title":"Parameters","text":"Name Type value? string"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_18","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Input/#validate","title":"validate","text":"

\u25b8 validate(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_19","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/","title":"Renderer.Component.MenuItem","text":"

@k8slens/extensions / Exports / Renderer / Component / MenuItem

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#class-menuitem","title":"Class: MenuItem","text":"

Renderer.Component.MenuItem

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#hierarchy","title":"Hierarchy","text":"
  • Component<MenuItemProps>

\u21b3 MenuItem

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#properties","title":"Properties","text":"
  • context
  • elem
  • contextType
  • defaultProps
"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#accessors","title":"Accessors","text":"
  • isFocusable
  • isLink
"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#methods","title":"Methods","text":"
  • bindRef
  • onClick
  • render
"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#constructor","title":"constructor","text":"

\u2022 new MenuItem(props)

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#parameters","title":"Parameters","text":"Name Type props MenuItemProps"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#overrides","title":"Overrides","text":"

React.Component<MenuItemProps\\>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#context","title":"context","text":"

\u2022 context: MenuContextValue

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#overrides_1","title":"Overrides","text":"

React.Component.context

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#elem","title":"elem","text":"

\u2022 elem: null | HTMLElement

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#contexttype","title":"contextType","text":"

\u25aa Static contextType: Context<null | MenuContextValue>

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#overrides_2","title":"Overrides","text":"

React.Component.contextType

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#defaultprops","title":"defaultProps","text":"

\u25aa Static defaultProps: object

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#isfocusable","title":"isFocusable","text":"

\u2022 get isFocusable(): boolean

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#returns","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#islink","title":"isLink","text":"

\u2022 get isLink(): boolean

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#returns_1","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#bindref","title":"bindRef","text":"

\u25b8 Protected bindRef(elem): void

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#parameters_1","title":"Parameters","text":"Name Type elem HTMLElement"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#onclick","title":"onClick","text":"

\u25b8 onClick(evt): void

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#parameters_2","title":"Parameters","text":"Name Type evt MouseEvent<Element, MouseEvent>"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#returns_4","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#overrides_3","title":"Overrides","text":"

React.Component.render

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/","title":"Renderer.Component.NotificationsStore","text":"

@k8slens/extensions / Exports / Renderer / Component / NotificationsStore

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#class-notificationsstore","title":"Class: NotificationsStore","text":"

Renderer.Component.NotificationsStore

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#properties","title":"Properties","text":"
  • autoHideTimers
  • notifications
"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#methods","title":"Methods","text":"
  • add
  • addAutoHideTimer
  • getById
  • remove
  • removeAutoHideTimer
"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#constructor","title":"constructor","text":"

\u2022 new NotificationsStore()

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#autohidetimers","title":"autoHideTimers","text":"

\u2022 Protected autoHideTimers: Map<NotificationId, number>

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#notifications","title":"notifications","text":"

\u2022 notifications: IObservableArray<{ id: NotificationId ; message: NotificationMessage ; onClose?: () => void ; status?: NotificationStatus ; timeout?: number }>

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#add","title":"add","text":"

\u25b8 add(rawNotification): () => void

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#parameters","title":"Parameters","text":"Name Type rawNotification Notification"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#returns","title":"Returns","text":"

fn

\u25b8 (): void

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#addautohidetimer","title":"addAutoHideTimer","text":"

\u25b8 addAutoHideTimer(id): void

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#parameters_1","title":"Parameters","text":"Name Type id NotificationId"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | { id: NotificationId ; message: NotificationMessage ; onClose?: () => void ; status?: NotificationStatus ; timeout?: number }

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#parameters_2","title":"Parameters","text":"Name Type id NotificationId"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#returns_3","title":"Returns","text":"

undefined | { id: NotificationId ; message: NotificationMessage ; onClose?: () => void ; status?: NotificationStatus ; timeout?: number }

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#remove","title":"remove","text":"

\u25b8 remove(id): void

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#parameters_3","title":"Parameters","text":"Name Type id NotificationId"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#returns_4","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#removeautohidetimer","title":"removeAutoHideTimer","text":"

\u25b8 removeAutoHideTimer(id): void

"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#parameters_4","title":"Parameters","text":"Name Type id NotificationId"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/","title":"Renderer.Component.PageLayout","text":"

@k8slens/extensions / Exports / Renderer / Component / PageLayout

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#class-pagelayout","title":"Class: PageLayout","text":"

Renderer.Component.PageLayout

PageLayout is deprecated. See MainLayout & SettingLayout

Deprecated

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#hierarchy","title":"Hierarchy","text":"
  • SettingLayout

\u21b3 PageLayout

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#properties","title":"Properties","text":"
  • onEscapeKey
  • defaultProps
"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#methods","title":"Methods","text":"
  • componentDidMount
  • componentWillUnmount
  • render
"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#constructor","title":"constructor","text":"

\u2022 new PageLayout(props)

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#parameters","title":"Parameters","text":"Name Type props SettingLayoutProps | Readonly<SettingLayoutProps>"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#inherited-from","title":"Inherited from","text":"

SettingLayout.constructor

\u2022 new PageLayout(props, context)

Deprecated

See

https://legacy.reactjs.org/docs/legacy-context.html

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#parameters_1","title":"Parameters","text":"Name Type props SettingLayoutProps context any"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#inherited-from_1","title":"Inherited from","text":"

SettingLayout.constructor

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#onescapekey","title":"onEscapeKey","text":"

\u2022 onEscapeKey: (evt: KeyboardEvent) => void

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#type-declaration","title":"Type declaration","text":"

\u25b8 (evt): void

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#parameters_2","title":"Parameters","text":"Name Type evt KeyboardEvent"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#inherited-from_2","title":"Inherited from","text":"

SettingLayout.onEscapeKey

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#defaultprops","title":"defaultProps","text":"

\u25aa Static defaultProps: object

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#inherited-from_3","title":"Inherited from","text":"

SettingLayout.defaultProps

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#componentdidmount","title":"componentDidMount","text":"

\u25b8 componentDidMount(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#returns_1","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#inherited-from_4","title":"Inherited from","text":"

SettingLayout.componentDidMount

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#componentwillunmount","title":"componentWillUnmount","text":"

\u25b8 componentWillUnmount(): void

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#inherited-from_5","title":"Inherited from","text":"

SettingLayout.componentWillUnmount

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#returns_3","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#inherited-from_6","title":"Inherited from","text":"

SettingLayout.render

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/","title":"Renderer.Component.SettingLayout","text":"

@k8slens/extensions / Exports / Renderer / Component / SettingLayout

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#class-settinglayout","title":"Class: SettingLayout","text":"

Renderer.Component.SettingLayout

Layout for settings like pages with navigation

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#hierarchy","title":"Hierarchy","text":"
  • Component<SettingLayoutProps>

\u21b3 SettingLayout

\u21b3\u21b3 PageLayout

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#properties","title":"Properties","text":"
  • onEscapeKey
  • defaultProps
"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#methods","title":"Methods","text":"
  • componentDidMount
  • componentWillUnmount
  • render
"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#constructor","title":"constructor","text":"

\u2022 new SettingLayout(props)

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#parameters","title":"Parameters","text":"Name Type props SettingLayoutProps | Readonly<SettingLayoutProps>"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#inherited-from","title":"Inherited from","text":"

React.Component<SettingLayoutProps>.constructor

\u2022 new SettingLayout(props, context)

Deprecated

See

https://legacy.reactjs.org/docs/legacy-context.html

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#parameters_1","title":"Parameters","text":"Name Type props SettingLayoutProps context any"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#inherited-from_1","title":"Inherited from","text":"

React.Component<SettingLayoutProps>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#onescapekey","title":"onEscapeKey","text":"

\u2022 onEscapeKey: (evt: KeyboardEvent) => void

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#type-declaration","title":"Type declaration","text":"

\u25b8 (evt): void

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#parameters_2","title":"Parameters","text":"Name Type evt KeyboardEvent"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#defaultprops","title":"defaultProps","text":"

\u25aa Static defaultProps: object

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#componentdidmount","title":"componentDidMount","text":"

\u25b8 componentDidMount(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#returns_1","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#overrides","title":"Overrides","text":"

React.Component.componentDidMount

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#componentwillunmount","title":"componentWillUnmount","text":"

\u25b8 componentWillUnmount(): void

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#overrides_1","title":"Overrides","text":"

React.Component.componentWillUnmount

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#returns_3","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#overrides_2","title":"Overrides","text":"

React.Component.render

"},{"location":"extensions/api/classes/Renderer.Component.Slider/","title":"Renderer.Component.Slider","text":"

@k8slens/extensions / Exports / Renderer / Component / Slider

"},{"location":"extensions/api/classes/Renderer.Component.Slider/#class-slider","title":"Class: Slider","text":"

Renderer.Component.Slider

"},{"location":"extensions/api/classes/Renderer.Component.Slider/#hierarchy","title":"Hierarchy","text":"
  • Component<SliderProps>

\u21b3 Slider

"},{"location":"extensions/api/classes/Renderer.Component.Slider/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.Slider/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.Slider/#properties","title":"Properties","text":"
  • defaultProps
"},{"location":"extensions/api/classes/Renderer.Component.Slider/#methods","title":"Methods","text":"
  • render
"},{"location":"extensions/api/classes/Renderer.Component.Slider/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.Slider/#constructor","title":"constructor","text":"

\u2022 new Slider(props)

"},{"location":"extensions/api/classes/Renderer.Component.Slider/#parameters","title":"Parameters","text":"Name Type props SliderProps | Readonly<SliderProps>"},{"location":"extensions/api/classes/Renderer.Component.Slider/#inherited-from","title":"Inherited from","text":"

Component<SliderProps>.constructor

\u2022 new Slider(props, context)

Deprecated

See

https://legacy.reactjs.org/docs/legacy-context.html

"},{"location":"extensions/api/classes/Renderer.Component.Slider/#parameters_1","title":"Parameters","text":"Name Type props SliderProps context any"},{"location":"extensions/api/classes/Renderer.Component.Slider/#inherited-from_1","title":"Inherited from","text":"

Component<SliderProps>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.Slider/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.Slider/#defaultprops","title":"defaultProps","text":"

\u25aa Static defaultProps: object

"},{"location":"extensions/api/classes/Renderer.Component.Slider/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.Slider/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.Slider/#returns","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.Slider/#overrides","title":"Overrides","text":"

Component.render

"},{"location":"extensions/api/classes/Renderer.Component.Spinner/","title":"Renderer.Component.Spinner","text":"

@k8slens/extensions / Exports / Renderer / Component / Spinner

"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#class-spinner","title":"Class: Spinner","text":"

Renderer.Component.Spinner

"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#hierarchy","title":"Hierarchy","text":"
  • Component<SpinnerProps, {}>

\u21b3 Spinner

"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.Spinner/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#properties","title":"Properties","text":"
  • defaultProps
"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#methods","title":"Methods","text":"
  • render
"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.Spinner/#constructor","title":"constructor","text":"

\u2022 new Spinner(props)

"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#parameters","title":"Parameters","text":"Name Type props SpinnerProps | Readonly<SpinnerProps>"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#inherited-from","title":"Inherited from","text":"

React.Component<SpinnerProps, {}>.constructor

\u2022 new Spinner(props, context)

Deprecated

See

https://legacy.reactjs.org/docs/legacy-context.html

"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#parameters_1","title":"Parameters","text":"Name Type props SpinnerProps context any"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#inherited-from_1","title":"Inherited from","text":"

React.Component<SpinnerProps, {}>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.Spinner/#defaultprops","title":"defaultProps","text":"

\u25aa Static defaultProps: Object

"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#type-declaration","title":"Type declaration","text":"Name Type center boolean singleColor boolean"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.Spinner/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#returns","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#overrides","title":"Overrides","text":"

React.Component.render

"},{"location":"extensions/api/classes/Renderer.Component.Stepper/","title":"Renderer.Component.Stepper","text":"

@k8slens/extensions / Exports / Renderer / Component / Stepper

"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#class-stepper","title":"Class: Stepper","text":"

Renderer.Component.Stepper

"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#hierarchy","title":"Hierarchy","text":"
  • Component<StepperProps, {}>

\u21b3 Stepper

"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.Stepper/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#methods","title":"Methods","text":"
  • render
"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.Stepper/#constructor","title":"constructor","text":"

\u2022 new Stepper(props)

"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#parameters","title":"Parameters","text":"Name Type props StepperProps | Readonly<StepperProps>"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#inherited-from","title":"Inherited from","text":"

React.Component<StepperProps, {}>.constructor

\u2022 new Stepper(props, context)

Deprecated

See

https://legacy.reactjs.org/docs/legacy-context.html

"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#parameters_1","title":"Parameters","text":"Name Type props StepperProps context any"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#inherited-from_1","title":"Inherited from","text":"

React.Component<StepperProps, {}>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.Stepper/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#returns","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#overrides","title":"Overrides","text":"

React.Component.render

"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/","title":"Renderer.Component.SubTitle","text":"

@k8slens/extensions / Exports / Renderer / Component / SubTitle

"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#class-subtitle","title":"Class: SubTitle","text":"

Renderer.Component.SubTitle

"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#hierarchy","title":"Hierarchy","text":"
  • Component<SubTitleProps>

\u21b3 SubTitle

"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#methods","title":"Methods","text":"
  • render
"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#constructor","title":"constructor","text":"

\u2022 new SubTitle(props)

"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#parameters","title":"Parameters","text":"Name Type props SubTitleProps | Readonly<SubTitleProps>"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#inherited-from","title":"Inherited from","text":"

React.Component<SubTitleProps>.constructor

\u2022 new SubTitle(props, context)

Deprecated

See

https://legacy.reactjs.org/docs/legacy-context.html

"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#parameters_1","title":"Parameters","text":"Name Type props SubTitleProps context any"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#inherited-from_1","title":"Inherited from","text":"

React.Component<SubTitleProps>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#returns","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#overrides","title":"Overrides","text":"

React.Component.render

"},{"location":"extensions/api/classes/Renderer.Component.Tab/","title":"Renderer.Component.Tab","text":"

@k8slens/extensions / Exports / Renderer / Component / Tab

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#class-tabd","title":"Class: Tab<D>","text":"

Renderer.Component.Tab

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#type-parameters","title":"Type parameters","text":"Name D"},{"location":"extensions/api/classes/Renderer.Component.Tab/#hierarchy","title":"Hierarchy","text":"
  • PureComponent<TabProps<D>>

\u21b3 Tab

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.Tab/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.Tab/#properties","title":"Properties","text":"
  • context
  • ref
  • contextType
"},{"location":"extensions/api/classes/Renderer.Component.Tab/#accessors","title":"Accessors","text":"
  • isActive
"},{"location":"extensions/api/classes/Renderer.Component.Tab/#methods","title":"Methods","text":"
  • componentDidMount
  • focus
  • onClick
  • onFocus
  • onKeyDown
  • render
  • scrollIntoView
"},{"location":"extensions/api/classes/Renderer.Component.Tab/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.Tab/#constructor","title":"constructor","text":"

\u2022 new Tab<D>(props)

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#type-parameters_1","title":"Type parameters","text":"Name D"},{"location":"extensions/api/classes/Renderer.Component.Tab/#parameters","title":"Parameters","text":"Name Type props TabProps<D>"},{"location":"extensions/api/classes/Renderer.Component.Tab/#overrides","title":"Overrides","text":"

React.PureComponent<TabProps<D\\>\\>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.Tab/#context","title":"context","text":"

\u2022 context: TabsContextValue<D>

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#overrides_1","title":"Overrides","text":"

React.PureComponent.context

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#ref","title":"ref","text":"

\u2022 ref: RefObject<HTMLDivElement>

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#contexttype","title":"contextType","text":"

\u25aa Static contextType: Context<TabsContextValue<unknown>>

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#overrides_2","title":"Overrides","text":"

React.PureComponent.contextType

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.Component.Tab/#isactive","title":"isActive","text":"

\u2022 get isActive(): boolean

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#returns","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.Tab/#componentdidmount","title":"componentDidMount","text":"

\u25b8 componentDidMount(): void

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#overrides_3","title":"Overrides","text":"

React.PureComponent.componentDidMount

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#focus","title":"focus","text":"

\u25b8 focus(): void

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#onclick","title":"onClick","text":"

\u25b8 onClick(evt): void

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#parameters_1","title":"Parameters","text":"Name Type evt MouseEvent<HTMLElement, MouseEvent>"},{"location":"extensions/api/classes/Renderer.Component.Tab/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#onfocus","title":"onFocus","text":"

\u25b8 onFocus(evt): void

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#parameters_2","title":"Parameters","text":"Name Type evt FocusEvent<HTMLElement, Element>"},{"location":"extensions/api/classes/Renderer.Component.Tab/#returns_4","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#onkeydown","title":"onKeyDown","text":"

\u25b8 onKeyDown(evt): void

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#parameters_3","title":"Parameters","text":"Name Type evt KeyboardEvent<HTMLElement>"},{"location":"extensions/api/classes/Renderer.Component.Tab/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#returns_6","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#overrides_4","title":"Overrides","text":"

React.PureComponent.render

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#scrollintoview","title":"scrollIntoView","text":"

\u25b8 scrollIntoView(): void

"},{"location":"extensions/api/classes/Renderer.Component.Tab/#returns_7","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.TableCell/","title":"Renderer.Component.TableCell","text":"

@k8slens/extensions / Exports / Renderer / Component / TableCell

"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#class-tablecell","title":"Class: TableCell","text":"

Renderer.Component.TableCell

"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#hierarchy","title":"Hierarchy","text":"
  • Component<TableCellProps>

\u21b3 TableCell

"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.TableCell/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#methods","title":"Methods","text":"
  • onClick
  • render
  • renderCheckbox
  • renderSortIcon
"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.TableCell/#constructor","title":"constructor","text":"

\u2022 new TableCell(props)

"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#parameters","title":"Parameters","text":"Name Type props TableCellProps"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#overrides","title":"Overrides","text":"

React.Component<TableCellProps\\>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.TableCell/#onclick","title":"onClick","text":"

\u25b8 onClick(evt): void

"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#parameters_1","title":"Parameters","text":"Name Type evt MouseEvent<HTMLDivElement, MouseEvent>"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#returns_1","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#overrides_1","title":"Overrides","text":"

React.Component.render

"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#rendercheckbox","title":"renderCheckbox","text":"

\u25b8 renderCheckbox(): null | Element

"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#returns_2","title":"Returns","text":"

null | Element

"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#rendersorticon","title":"renderSortIcon","text":"

\u25b8 renderSortIcon(): null | Element

"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#returns_3","title":"Returns","text":"

null | Element

"},{"location":"extensions/api/classes/Renderer.Component.TableHead/","title":"Renderer.Component.TableHead","text":"

@k8slens/extensions / Exports / Renderer / Component / TableHead

"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#class-tablehead","title":"Class: TableHead","text":"

Renderer.Component.TableHead

"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#hierarchy","title":"Hierarchy","text":"
  • Component<TableHeadProps>

\u21b3 TableHead

"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.TableHead/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#properties","title":"Properties","text":"
  • defaultProps
"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#methods","title":"Methods","text":"
  • render
"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.TableHead/#constructor","title":"constructor","text":"

\u2022 new TableHead(props)

"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#parameters","title":"Parameters","text":"Name Type props TableHeadProps | Readonly<TableHeadProps>"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#inherited-from","title":"Inherited from","text":"

React.Component<TableHeadProps>.constructor

\u2022 new TableHead(props, context)

Deprecated

See

https://legacy.reactjs.org/docs/legacy-context.html

"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#parameters_1","title":"Parameters","text":"Name Type props TableHeadProps context any"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#inherited-from_1","title":"Inherited from","text":"

React.Component<TableHeadProps>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.TableHead/#defaultprops","title":"defaultProps","text":"

\u25aa Static defaultProps: TableHeadProps

"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.TableHead/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#returns","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#overrides","title":"Overrides","text":"

React.Component.render

"},{"location":"extensions/api/classes/Renderer.Component.TableRow/","title":"Renderer.Component.TableRow","text":"

@k8slens/extensions / Exports / Renderer / Component / TableRow

"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#class-tablerowitem","title":"Class: TableRow<Item>","text":"

Renderer.Component.TableRow

"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#type-parameters","title":"Type parameters","text":"Name Item"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#hierarchy","title":"Hierarchy","text":"
  • Component<TableRowProps<Item>>

\u21b3 TableRow

"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.TableRow/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#methods","title":"Methods","text":"
  • render
"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.TableRow/#constructor","title":"constructor","text":"

\u2022 new TableRow<Item>(props)

"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#type-parameters_1","title":"Type parameters","text":"Name Item"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#parameters","title":"Parameters","text":"Name Type props TableRowProps<Item> | Readonly<TableRowProps<Item>>"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#inherited-from","title":"Inherited from","text":"

React.Component<TableRowProps<Item>>.constructor

\u2022 new TableRow<Item>(props, context)

Deprecated

See

https://legacy.reactjs.org/docs/legacy-context.html

"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#type-parameters_2","title":"Type parameters","text":"Name Item"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#parameters_1","title":"Parameters","text":"Name Type props TableRowProps<Item> context any"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#inherited-from_1","title":"Inherited from","text":"

React.Component<TableRowProps<Item>>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.TableRow/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#returns","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#overrides","title":"Overrides","text":"

React.Component.render

"},{"location":"extensions/api/classes/Renderer.Component.Tabs/","title":"Renderer.Component.Tabs","text":"

@k8slens/extensions / Exports / Renderer / Component / Tabs

"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#class-tabsd","title":"Class: Tabs<D>","text":"

Renderer.Component.Tabs

"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#type-parameters","title":"Type parameters","text":"Name D"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#hierarchy","title":"Hierarchy","text":"
  • PureComponent<TabsProps<D>>

\u21b3 Tabs

"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.Tabs/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#properties","title":"Properties","text":"
  • elem
"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#methods","title":"Methods","text":"
  • render
"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.Tabs/#constructor","title":"constructor","text":"

\u2022 new Tabs<D>(props)

"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#type-parameters_1","title":"Type parameters","text":"Name D"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#parameters","title":"Parameters","text":"Name Type props TabsProps<D> | Readonly<TabsProps<D>>"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#inherited-from","title":"Inherited from","text":"

React.PureComponent<TabsProps<D>>.constructor

\u2022 new Tabs<D>(props, context)

Deprecated

See

https://legacy.reactjs.org/docs/legacy-context.html

"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#type-parameters_2","title":"Type parameters","text":"Name D"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#parameters_1","title":"Parameters","text":"Name Type props TabsProps<D> context any"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#inherited-from_1","title":"Inherited from","text":"

React.PureComponent<TabsProps<D>>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.Tabs/#elem","title":"elem","text":"

\u2022 elem: null | HTMLDivElement

"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.Tabs/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#returns","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#overrides","title":"Overrides","text":"

React.PureComponent.render

"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/","title":"Renderer.Component.TerminalStore","text":"

@k8slens/extensions / Exports / Renderer / Component / TerminalStore

"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#class-terminalstore","title":"Class: TerminalStore","text":"

Renderer.Component.TerminalStore

"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#methods","title":"Methods","text":"
  • createInstance
  • getInstance
  • resetInstance
"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#constructor","title":"constructor","text":"

\u2022 new TerminalStore()

"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#createinstance","title":"createInstance","text":"

\u25b8 Static createInstance(): TerminalStore & { sendCommand: SendCommand }

"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#returns","title":"Returns","text":"

TerminalStore & { sendCommand: SendCommand }

"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#getinstance","title":"getInstance","text":"

\u25b8 Static getInstance(): TerminalStore & { sendCommand: SendCommand }

"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#returns_1","title":"Returns","text":"

TerminalStore & { sendCommand: SendCommand }

"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#resetinstance","title":"resetInstance","text":"

\u25b8 Static resetInstance(): void

"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/","title":"Renderer.Component.Wizard","text":"

@k8slens/extensions / Exports / Renderer / Component / Wizard

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#class-wizardd","title":"Class: Wizard<D>","text":"

Renderer.Component.Wizard

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#type-parameters","title":"Type parameters","text":"Name D"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#hierarchy","title":"Hierarchy","text":"
  • Component<WizardProps<D>, State>

\u21b3 Wizard

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.Wizard/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#properties","title":"Properties","text":"
  • firstStep
  • isFirstStep
  • isLastStep
  • lastStep
  • nextStep
  • prevStep
  • state
"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#accessors","title":"Accessors","text":"
  • step
  • steps
"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#methods","title":"Methods","text":"
  • getValidStep
  • render
"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.Wizard/#constructor","title":"constructor","text":"

\u2022 new Wizard<D>(props)

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#type-parameters_1","title":"Type parameters","text":"Name D"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#parameters","title":"Parameters","text":"Name Type props WizardProps<D> | Readonly<WizardProps<D>>"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#inherited-from","title":"Inherited from","text":"

React.Component<WizardProps<D>, State>.constructor

\u2022 new Wizard<D>(props, context)

Deprecated

See

https://legacy.reactjs.org/docs/legacy-context.html

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#type-parameters_2","title":"Type parameters","text":"Name D"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#parameters_1","title":"Parameters","text":"Name Type props WizardProps<D> context any"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#inherited-from_1","title":"Inherited from","text":"

React.Component<WizardProps<D>, State>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.Wizard/#firststep","title":"firstStep","text":"

\u2022 firstStep: () => any

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#type-declaration","title":"Type declaration","text":"

\u25b8 (): any

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#returns","title":"Returns","text":"

any

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#isfirststep","title":"isFirstStep","text":"

\u2022 isFirstStep: () => boolean

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (): boolean

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#returns_1","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#islaststep","title":"isLastStep","text":"

\u2022 isLastStep: () => boolean

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (): boolean

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#returns_2","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#laststep","title":"lastStep","text":"

\u2022 lastStep: () => any

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (): any

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#returns_3","title":"Returns","text":"

any

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#nextstep","title":"nextStep","text":"

\u2022 nextStep: () => any

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (): any

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#returns_4","title":"Returns","text":"

any

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#prevstep","title":"prevStep","text":"

\u2022 prevStep: () => any

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (): any

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#returns_5","title":"Returns","text":"

any

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#state","title":"state","text":"

\u2022 state: State

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#overrides","title":"Overrides","text":"

React.Component.state

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.Component.Wizard/#step","title":"step","text":"

\u2022 get step(): number

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#returns_6","title":"Returns","text":"

number

\u2022 set step(step): void

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#parameters_2","title":"Parameters","text":"Name Type step number"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#returns_7","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#steps","title":"steps","text":"

\u2022 get steps(): ReactElement<WizardStepProps<D>, string | JSXElementConstructor<any>>[]

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#returns_8","title":"Returns","text":"

ReactElement<WizardStepProps<D>, string | JSXElementConstructor<any>>[]

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.Wizard/#getvalidstep","title":"getValidStep","text":"

\u25b8 Protected getValidStep(step): number

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#parameters_3","title":"Parameters","text":"Name Type step number"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#returns_9","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#returns_10","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#overrides_1","title":"Overrides","text":"

React.Component.render

"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/","title":"Renderer.Component.WizardLayout","text":"

@k8slens/extensions / Exports / Renderer / Component / WizardLayout

"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#class-wizardlayout","title":"Class: WizardLayout","text":"

Renderer.Component.WizardLayout

"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#hierarchy","title":"Hierarchy","text":"
  • Component<WizardLayoutProps>

\u21b3 WizardLayout

"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#methods","title":"Methods","text":"
  • render
"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#constructor","title":"constructor","text":"

\u2022 new WizardLayout(props)

"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#parameters","title":"Parameters","text":"Name Type props WizardLayoutProps | Readonly<WizardLayoutProps>"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#inherited-from","title":"Inherited from","text":"

React.Component<WizardLayoutProps>.constructor

\u2022 new WizardLayout(props, context)

Deprecated

See

https://legacy.reactjs.org/docs/legacy-context.html

"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#parameters_1","title":"Parameters","text":"Name Type props WizardLayoutProps context any"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#inherited-from_1","title":"Inherited from","text":"

React.Component<WizardLayoutProps>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#render","title":"render","text":"

\u25b8 render(): Element

"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#returns","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#overrides","title":"Overrides","text":"

React.Component.render

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/","title":"Renderer.Component.WizardStep","text":"

@k8slens/extensions / Exports / Renderer / Component / WizardStep

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#class-wizardstepd","title":"Class: WizardStep<D>","text":"

Renderer.Component.WizardStep

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#type-parameters","title":"Type parameters","text":"Name D"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#hierarchy","title":"Hierarchy","text":"
  • Component<WizardStepProps<D>, WizardStepState>

\u21b3 WizardStep

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#properties","title":"Properties","text":"
  • next
  • prev
  • state
  • submit
  • defaultProps
"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#methods","title":"Methods","text":"
  • componentWillUnmount
  • keyDown
  • render
  • renderLoading
"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#constructor","title":"constructor","text":"

\u2022 new WizardStep<D>(props)

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#type-parameters_1","title":"Type parameters","text":"Name D"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#parameters","title":"Parameters","text":"Name Type props WizardStepProps<D> | Readonly<WizardStepProps<D>>"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#inherited-from","title":"Inherited from","text":"

React.Component<WizardStepProps<D>, WizardStepState>.constructor

\u2022 new WizardStep<D>(props, context)

Deprecated

See

https://legacy.reactjs.org/docs/legacy-context.html

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#type-parameters_2","title":"Type parameters","text":"Name D"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#parameters_1","title":"Parameters","text":"Name Type props WizardStepProps<D> context any"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#inherited-from_1","title":"Inherited from","text":"

React.Component<WizardStepProps<D>, WizardStepState>.constructor

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#next","title":"next","text":"

\u2022 next: () => void

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#type-declaration","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#prev","title":"prev","text":"

\u2022 prev: () => void

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#state","title":"state","text":"

\u2022 state: WizardStepState

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#overrides","title":"Overrides","text":"

React.Component.state

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#submit","title":"submit","text":"

\u2022 submit: DebouncedFunc<() => void>

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#defaultprops","title":"defaultProps","text":"

\u25aa Static defaultProps: WizardStepProps<any>

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#componentwillunmount","title":"componentWillUnmount","text":"

\u25b8 componentWillUnmount(): void

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#overrides_1","title":"Overrides","text":"

React.Component.componentWillUnmount

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#keydown","title":"keyDown","text":"

\u25b8 keyDown(evt): void

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#parameters_2","title":"Parameters","text":"Name Type evt KeyboardEvent<HTMLElement>"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#render","title":"render","text":"

\u25b8 render(): null | Element

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#returns_4","title":"Returns","text":"

null | Element

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#overrides_2","title":"Overrides","text":"

React.Component.render

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#renderloading","title":"renderLoading","text":"

\u25b8 renderLoading(): Element

"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#returns_5","title":"Returns","text":"

Element

"},{"location":"extensions/api/classes/Renderer.Ipc/","title":"Renderer.Ipc","text":"

@k8slens/extensions / Exports / Renderer / Ipc

"},{"location":"extensions/api/classes/Renderer.Ipc/#class-ipc","title":"Class: Ipc","text":"

Renderer.Ipc

"},{"location":"extensions/api/classes/Renderer.Ipc/#hierarchy","title":"Hierarchy","text":"
  • IpcRegistrar

\u21b3 Ipc

"},{"location":"extensions/api/classes/Renderer.Ipc/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Ipc/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Ipc/#properties","title":"Properties","text":"
  • [IpcPrefix]
  • extension
"},{"location":"extensions/api/classes/Renderer.Ipc/#methods","title":"Methods","text":"
  • broadcast
  • invoke
  • listen
  • createInstance
  • getInstance
  • resetInstance
"},{"location":"extensions/api/classes/Renderer.Ipc/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Ipc/#constructor","title":"constructor","text":"

\u2022 new Ipc(extension)

"},{"location":"extensions/api/classes/Renderer.Ipc/#parameters","title":"Parameters","text":"Name Type extension LensExtension"},{"location":"extensions/api/classes/Renderer.Ipc/#overrides","title":"Overrides","text":"

IpcRegistrar.constructor

"},{"location":"extensions/api/classes/Renderer.Ipc/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Ipc/#ipcprefix","title":"[IpcPrefix]","text":"

\u2022 Readonly [IpcPrefix]: string

"},{"location":"extensions/api/classes/Renderer.Ipc/#inherited-from","title":"Inherited from","text":"

IpcRegistrar.[IpcPrefix]

"},{"location":"extensions/api/classes/Renderer.Ipc/#extension","title":"extension","text":"

\u2022 Protected Readonly extension: LensExtension

"},{"location":"extensions/api/classes/Renderer.Ipc/#inherited-from_1","title":"Inherited from","text":"

IpcRegistrar.extension

"},{"location":"extensions/api/classes/Renderer.Ipc/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Ipc/#broadcast","title":"broadcast","text":"

\u25b8 broadcast(channel, ...args): void

"},{"location":"extensions/api/classes/Renderer.Ipc/#parameters_1","title":"Parameters","text":"Name Type Description channel string The channel to broadcast to your whole extension, both main and renderer ...args any[] The arguments passed to all listeners"},{"location":"extensions/api/classes/Renderer.Ipc/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Ipc/#inherited-from_2","title":"Inherited from","text":"

IpcRegistrar.broadcast

"},{"location":"extensions/api/classes/Renderer.Ipc/#invoke","title":"invoke","text":"

\u25b8 invoke(channel, ...args): Promise<any>

Request main to execute its function over the channel channel. This function only interacts with functions registered via Ipc.IpcMain.handleRpc An error will be thrown if no function has been registered on main with this channel ID.

"},{"location":"extensions/api/classes/Renderer.Ipc/#parameters_2","title":"Parameters","text":"Name Type Description channel string The channel to invoke a RPC on ...args any[] The arguments to pass to the RPC"},{"location":"extensions/api/classes/Renderer.Ipc/#returns_1","title":"Returns","text":"

Promise<any>

A promise of the resulting value

"},{"location":"extensions/api/classes/Renderer.Ipc/#listen","title":"listen","text":"

\u25b8 listen(channel, listener): Disposer

Listen for broadcasts within your extension. If the lifetime of the listener should be tied to the mounted lifetime of a component then putting the returned value in a disposeOnUnmount call will suffice.

"},{"location":"extensions/api/classes/Renderer.Ipc/#parameters_3","title":"Parameters","text":"Name Type Description channel string The channel to listen for broadcasts on listener (event: IpcRendererEvent, ...args: any[]) => any The function that will be called with the arguments of the broadcast"},{"location":"extensions/api/classes/Renderer.Ipc/#returns_2","title":"Returns","text":"

Disposer

An optional disposer, Lens will cleanup even if this is not called

"},{"location":"extensions/api/classes/Renderer.Ipc/#createinstance","title":"createInstance","text":"

\u25b8 Static createInstance<T, R>(this, ...args): T

Creates the single instance of the child class if one was not already created.

Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls.

Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used.

"},{"location":"extensions/api/classes/Renderer.Ipc/#type-parameters","title":"Type parameters","text":"Name Type T extends Singleton<T> R extends any[]"},{"location":"extensions/api/classes/Renderer.Ipc/#parameters_4","title":"Parameters","text":"Name Type Description this StaticThis<T, R> Implicit argument that is the child class type ...args R The constructor arguments for the child class"},{"location":"extensions/api/classes/Renderer.Ipc/#returns_3","title":"Returns","text":"

T

An instance of the child class

"},{"location":"extensions/api/classes/Renderer.Ipc/#inherited-from_3","title":"Inherited from","text":"

IpcRegistrar.createInstance

"},{"location":"extensions/api/classes/Renderer.Ipc/#getinstance","title":"getInstance","text":"

\u25b8 Static getInstance<T, R>(this, strict?): T

Get the instance of the child class that was previously created.

"},{"location":"extensions/api/classes/Renderer.Ipc/#type-parameters_1","title":"Type parameters","text":"Name Type T T R extends any[]"},{"location":"extensions/api/classes/Renderer.Ipc/#parameters_5","title":"Parameters","text":"Name Type Description this StaticThis<T, R> Implicit argument that is the child class type strict? true If false will return undefined instead of throwing when an instance doesn't exist. Default: true"},{"location":"extensions/api/classes/Renderer.Ipc/#returns_4","title":"Returns","text":"

T

An instance of the child class

"},{"location":"extensions/api/classes/Renderer.Ipc/#inherited-from_4","title":"Inherited from","text":"

IpcRegistrar.getInstance

\u25b8 Static getInstance<T, R>(this, strict): undefined | T

"},{"location":"extensions/api/classes/Renderer.Ipc/#type-parameters_2","title":"Type parameters","text":"Name Type T T R extends any[]"},{"location":"extensions/api/classes/Renderer.Ipc/#parameters_6","title":"Parameters","text":"Name Type this StaticThis<T, R> strict false"},{"location":"extensions/api/classes/Renderer.Ipc/#returns_5","title":"Returns","text":"

undefined | T

"},{"location":"extensions/api/classes/Renderer.Ipc/#inherited-from_5","title":"Inherited from","text":"

IpcRegistrar.getInstance

"},{"location":"extensions/api/classes/Renderer.Ipc/#resetinstance","title":"resetInstance","text":"

\u25b8 Static resetInstance(): void

Delete the instance of the child class.

Note: this doesn't prevent callers of getInstance from storing the result in a global.

There is no way in JS or TS to prevent globals like that.

"},{"location":"extensions/api/classes/Renderer.Ipc/#returns_6","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Ipc/#inherited-from_6","title":"Inherited from","text":"

IpcRegistrar.resetInstance

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/","title":"Renderer.K8sApi.CRDResourceStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / CRDResourceStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#class-crdresourcestorek","title":"Class: CRDResourceStore<K>","text":"

Renderer.K8sApi.CRDResourceStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#type-parameters","title":"Type parameters","text":"Name Type K extends KubeObject"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<K, KubeApi<K>>

\u21b3 CRDResourceStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#constructor","title":"constructor","text":"

\u2022 new CRDResourceStore<K>(deps, api)

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#type-parameters_1","title":"Type parameters","text":"Name Type K extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, K>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters","title":"Parameters","text":"Name Type deps KubeObjectStoreDependencies api KubeApi<K, KubeJsonApiDataFor<K>>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#overrides","title":"Overrides","text":"

KubeObjectStore<K, KubeApi<K\\>\\>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#api","title":"api","text":"

\u2022 Readonly api: KubeApi<K, KubeJsonApiDataFor<K>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: K) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_1","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiDataFor<K> extends KubeJsonApiDataFor<K> ? KubeJsonApiDataFor<K> : never>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#items","title":"items","text":"

\u2022 items: IObservableArray<K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<K, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_4","title":"Returns","text":"

Generator<K, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialDeep<K, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_6","title":"Returns","text":"

Promise<K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialDeep<K, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_7","title":"Returns","text":"

Promise<null | K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_5","title":"Parameters","text":"Name Type items K[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_8","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_9","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | K

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_10","title":"Returns","text":"

undefined | K

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_11","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | K

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_12","title":"Returns","text":"

undefined | K

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | K

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_13","title":"Returns","text":"

undefined | K

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_15","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_12","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? K[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#load","title":"load","text":"

\u25b8 load(params): Promise<K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_19","title":"Returns","text":"

Promise<K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | K[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_20","title":"Returns","text":"

Promise<undefined | K[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_21","title":"Returns","text":"

Promise<K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_22","title":"Returns","text":"

Promise<null | K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<K[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_23","title":"Returns","text":"

Promise<K[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_19","title":"Parameters","text":"Name Type partialItems K[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_24","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_20","title":"Parameters","text":"Name Type item K patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_25","title":"Returns","text":"

Promise<K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_21","title":"Parameters","text":"Name Type items K[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_26","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | K[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_27","title":"Returns","text":"

Promise<undefined | K[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_23","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_24","title":"Parameters","text":"Name Type item K request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_25","title":"Parameters","text":"Name Type items K[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_27","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): K[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_28","title":"Parameters","text":"Name Type Description items? K[] the items to be sorted (default: the current items in this store) sorting? (item: K) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_36","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_30","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? K[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_32","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_33","title":"Parameters","text":"Name Type item K data PartialDeep<K, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_41","title":"Returns","text":"

Promise<K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters_34","title":"Parameters","text":"Name Type item K request () => Promise<K>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_43","title":"Returns","text":"

Promise<K>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/","title":"Renderer.K8sApi.CRDStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / CRDStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#class-crdstore","title":"Class: CRDStore","text":"

Renderer.K8sApi.CRDStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<CustomResourceDefinition, CustomResourceDefinitionApi>

\u21b3 CRDStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#accessors","title":"Accessors","text":"
  • contextItems
  • groups
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getByGroup
  • getById
  • getByLabel
  • getByName
  • getByObject
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#constructor","title":"constructor","text":"

\u2022 new CRDStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api CustomResourceDefinitionApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#overrides","title":"Overrides","text":"

KubeObjectStore<CustomResourceDefinition, CustomResourceDefinitionApi\\>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#api","title":"api","text":"

\u2022 Readonly api: CustomResourceDefinitionApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: CustomResourceDefinition) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_1","title":"Parameters","text":"Name Type item CustomResourceDefinition"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<ClusterScopedMetadata, CustomResourceDefinitionStatus, CustomResourceDefinitionSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#items","title":"items","text":"

\u2022 items: IObservableArray<CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#groups","title":"groups","text":"

\u2022 get groups(): Record<string, CustomResourceDefinition[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_2","title":"Returns","text":"

Record<string, CustomResourceDefinition[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_3","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_4","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<CustomResourceDefinition, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_5","title":"Returns","text":"

Generator<CustomResourceDefinition, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_6","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<CustomResourceDefinition, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_7","title":"Returns","text":"

Promise<CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<CustomResourceDefinition, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_8","title":"Returns","text":"

Promise<null | CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): CustomResourceDefinition[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_5","title":"Parameters","text":"Name Type items CustomResourceDefinition[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_9","title":"Returns","text":"

CustomResourceDefinition[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): CustomResourceDefinition[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_10","title":"Returns","text":"

CustomResourceDefinition[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbygroup","title":"getByGroup","text":"

\u25b8 getByGroup(group, pluralName): undefined | CustomResourceDefinition

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_7","title":"Parameters","text":"Name Type group string pluralName string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_11","title":"Returns","text":"

undefined | CustomResourceDefinition

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | CustomResourceDefinition

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_8","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_12","title":"Returns","text":"

undefined | CustomResourceDefinition

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): CustomResourceDefinition[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_9","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_13","title":"Returns","text":"

CustomResourceDefinition[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | CustomResourceDefinition

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_10","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_14","title":"Returns","text":"

undefined | CustomResourceDefinition

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbyobject","title":"getByObject","text":"

\u25b8 getByObject(obj): undefined | CustomResourceDefinition

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_11","title":"Parameters","text":"Name Type obj KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_15","title":"Returns","text":"

undefined | CustomResourceDefinition

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | CustomResourceDefinition

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_12","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_16","title":"Returns","text":"

undefined | CustomResourceDefinition

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_13","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_17","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): CustomResourceDefinition[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_18","title":"Returns","text":"

CustomResourceDefinition[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_19","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_14","title":"Parameters","text":"Name Type item CustomResourceDefinition"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_20","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_15","title":"Parameters","text":"Name Type visibleItems? CustomResourceDefinition[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_21","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#load","title":"load","text":"

\u25b8 load(params): Promise<CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_16","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_22","title":"Returns","text":"

Promise<CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | CustomResourceDefinition[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_17","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_23","title":"Returns","text":"

Promise<undefined | CustomResourceDefinition[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_18","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_24","title":"Returns","text":"

Promise<CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_19","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_25","title":"Returns","text":"

Promise<null | CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<CustomResourceDefinition[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_20","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_26","title":"Returns","text":"

Promise<CustomResourceDefinition[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): CustomResourceDefinition[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_21","title":"Parameters","text":"Name Type partialItems CustomResourceDefinition[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_27","title":"Returns","text":"

CustomResourceDefinition[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_22","title":"Parameters","text":"Name Type item CustomResourceDefinition patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_28","title":"Returns","text":"

Promise<CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): CustomResourceDefinition[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_23","title":"Parameters","text":"Name Type items CustomResourceDefinition[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_29","title":"Returns","text":"

CustomResourceDefinition[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | CustomResourceDefinition[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_24","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_30","title":"Returns","text":"

Promise<undefined | CustomResourceDefinition[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_25","title":"Parameters","text":"Name Type item CustomResourceDefinition"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_26","title":"Parameters","text":"Name Type item CustomResourceDefinition request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_32","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_27","title":"Parameters","text":"Name Type items CustomResourceDefinition[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_33","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_34","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_28","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_36","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_37","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_29","title":"Parameters","text":"Name Type item CustomResourceDefinition"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items): CustomResourceDefinition[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_30","title":"Parameters","text":"Name Type items CustomResourceDefinition[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_39","title":"Returns","text":"

CustomResourceDefinition[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#overrides_1","title":"Overrides","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_31","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_40","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_32","title":"Parameters","text":"Name Type item CustomResourceDefinition"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_41","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_33","title":"Parameters","text":"Name Type visibleItems? CustomResourceDefinition[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_34","title":"Parameters","text":"Name Type item CustomResourceDefinition"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_43","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_35","title":"Parameters","text":"Name Type item CustomResourceDefinition data PartialObjectDeep<CustomResourceDefinition, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_44","title":"Returns","text":"

Promise<CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_45","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#parameters_36","title":"Parameters","text":"Name Type item CustomResourceDefinition request () => Promise<CustomResourceDefinition>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_46","title":"Returns","text":"

Promise<CustomResourceDefinition>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/","title":"Renderer.K8sApi.ConfigMapsStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / ConfigMapsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#class-configmapsstore","title":"Class: ConfigMapsStore","text":"

Renderer.K8sApi.ConfigMapsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<ConfigMap, ConfigMapApi, ConfigMapData>

\u21b3 ConfigMapsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#constructor","title":"constructor","text":"

\u2022 new ConfigMapsStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api ConfigMapApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<ConfigMap, ConfigMapApi, ConfigMapData>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#api","title":"api","text":"

\u2022 Readonly api: ConfigMapApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: ConfigMap) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_1","title":"Parameters","text":"Name Type item ConfigMap"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<ConfigMapData>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#items","title":"items","text":"

\u2022 items: IObservableArray<ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<ConfigMap, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_4","title":"Returns","text":"

Generator<ConfigMap, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<ConfigMap, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_6","title":"Returns","text":"

Promise<ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<ConfigMap, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_7","title":"Returns","text":"

Promise<null | ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): ConfigMap[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_5","title":"Parameters","text":"Name Type items ConfigMap[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_8","title":"Returns","text":"

ConfigMap[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): ConfigMap[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_9","title":"Returns","text":"

ConfigMap[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | ConfigMap

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_10","title":"Returns","text":"

undefined | ConfigMap

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): ConfigMap[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_11","title":"Returns","text":"

ConfigMap[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | ConfigMap

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_12","title":"Returns","text":"

undefined | ConfigMap

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | ConfigMap

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_13","title":"Returns","text":"

undefined | ConfigMap

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): ConfigMap[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_15","title":"Returns","text":"

ConfigMap[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_12","title":"Parameters","text":"Name Type item ConfigMap"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? ConfigMap[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#load","title":"load","text":"

\u25b8 load(params): Promise<ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_19","title":"Returns","text":"

Promise<ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | ConfigMap[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_20","title":"Returns","text":"

Promise<undefined | ConfigMap[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_21","title":"Returns","text":"

Promise<ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_22","title":"Returns","text":"

Promise<null | ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<ConfigMap[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_23","title":"Returns","text":"

Promise<ConfigMap[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): ConfigMap[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_19","title":"Parameters","text":"Name Type partialItems ConfigMap[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_24","title":"Returns","text":"

ConfigMap[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_20","title":"Parameters","text":"Name Type item ConfigMap patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_25","title":"Returns","text":"

Promise<ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): ConfigMap[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_21","title":"Parameters","text":"Name Type items ConfigMap[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_26","title":"Returns","text":"

ConfigMap[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | ConfigMap[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_27","title":"Returns","text":"

Promise<undefined | ConfigMap[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_23","title":"Parameters","text":"Name Type item ConfigMap"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_24","title":"Parameters","text":"Name Type item ConfigMap request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_25","title":"Parameters","text":"Name Type items ConfigMap[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_27","title":"Parameters","text":"Name Type item ConfigMap"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): ConfigMap[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_28","title":"Parameters","text":"Name Type Description items? ConfigMap[] the items to be sorted (default: the current items in this store) sorting? (item: ConfigMap) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_36","title":"Returns","text":"

ConfigMap[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_30","title":"Parameters","text":"Name Type item ConfigMap"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? ConfigMap[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_32","title":"Parameters","text":"Name Type item ConfigMap"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_33","title":"Parameters","text":"Name Type item ConfigMap data PartialObjectDeep<ConfigMap, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_41","title":"Returns","text":"

Promise<ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#parameters_34","title":"Parameters","text":"Name Type item ConfigMap request () => Promise<ConfigMap>"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_43","title":"Returns","text":"

Promise<ConfigMap>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/","title":"Renderer.K8sApi.CronJobStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / CronJobStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#class-cronjobstore","title":"Class: CronJobStore","text":"

Renderer.K8sApi.CronJobStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<CronJob, CronJobApi>

\u21b3 CronJobStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getActiveJobsNum
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getStatuses
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#constructor","title":"constructor","text":"

\u2022 new CronJobStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters","title":"Parameters","text":"Name Type dependencies Dependencies api CronJobApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#overrides","title":"Overrides","text":"

KubeObjectStore<CronJob, CronJobApi\\>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#api","title":"api","text":"

\u2022 Readonly api: CronJobApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: CronJob) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_1","title":"Parameters","text":"Name Type item CronJob"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: Dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#overrides_1","title":"Overrides","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, CronJobStatus, CronJobSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#items","title":"items","text":"

\u2022 items: IObservableArray<CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<CronJob, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_4","title":"Returns","text":"

Generator<CronJob, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<CronJob, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_6","title":"Returns","text":"

Promise<CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<CronJob, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_7","title":"Returns","text":"

Promise<null | CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): CronJob[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_5","title":"Parameters","text":"Name Type items CronJob[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_8","title":"Returns","text":"

CronJob[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getactivejobsnum","title":"getActiveJobsNum","text":"

\u25b8 getActiveJobsNum(cronJob): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_6","title":"Parameters","text":"Name Type cronJob CronJob"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_9","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): CronJob[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_7","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_10","title":"Returns","text":"

CronJob[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | CronJob

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_8","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_11","title":"Returns","text":"

undefined | CronJob

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): CronJob[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_9","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_12","title":"Returns","text":"

CronJob[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | CronJob

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_10","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_13","title":"Returns","text":"

undefined | CronJob

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | CronJob

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_11","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_14","title":"Returns","text":"

undefined | CronJob

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_12","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): CronJob[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_16","title":"Returns","text":"

CronJob[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getstatuses","title":"getStatuses","text":"

\u25b8 getStatuses(cronJobs?): Object

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_13","title":"Parameters","text":"Name Type cronJobs? CronJob[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_17","title":"Returns","text":"

Object

Name Type scheduled number suspended number"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_18","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_14","title":"Parameters","text":"Name Type item CronJob"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_19","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_15","title":"Parameters","text":"Name Type visibleItems? CronJob[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_20","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#load","title":"load","text":"

\u25b8 load(params): Promise<CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_16","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_21","title":"Returns","text":"

Promise<CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | CronJob[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_17","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_22","title":"Returns","text":"

Promise<undefined | CronJob[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_18","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_23","title":"Returns","text":"

Promise<CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_19","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_24","title":"Returns","text":"

Promise<null | CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<CronJob[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_20","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_25","title":"Returns","text":"

Promise<CronJob[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): CronJob[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_21","title":"Parameters","text":"Name Type partialItems CronJob[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_26","title":"Returns","text":"

CronJob[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_22","title":"Parameters","text":"Name Type item CronJob patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_27","title":"Returns","text":"

Promise<CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): CronJob[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_23","title":"Parameters","text":"Name Type items CronJob[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_28","title":"Returns","text":"

CronJob[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | CronJob[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_24","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_29","title":"Returns","text":"

Promise<undefined | CronJob[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_25","title":"Parameters","text":"Name Type item CronJob"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_26","title":"Parameters","text":"Name Type item CronJob request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_27","title":"Parameters","text":"Name Type items CronJob[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_32","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_33","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_28","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_36","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_29","title":"Parameters","text":"Name Type item CronJob"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_37","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): CronJob[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_30","title":"Parameters","text":"Name Type Description items? CronJob[] the items to be sorted (default: the current items in this store) sorting? (item: CronJob) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_38","title":"Returns","text":"

CronJob[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_31","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_39","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_32","title":"Parameters","text":"Name Type item CronJob"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_33","title":"Parameters","text":"Name Type visibleItems? CronJob[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_41","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_34","title":"Parameters","text":"Name Type item CronJob"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_35","title":"Parameters","text":"Name Type item CronJob data PartialObjectDeep<CronJob, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_43","title":"Returns","text":"

Promise<CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_44","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#parameters_36","title":"Parameters","text":"Name Type item CronJob request () => Promise<CronJob>"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_45","title":"Returns","text":"

Promise<CronJob>

"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/","title":"Renderer.K8sApi.DaemonSetStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / DaemonSetStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#class-daemonsetstore","title":"Class: DaemonSetStore","text":"

Renderer.K8sApi.DaemonSetStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<DaemonSet, DaemonSetApi>

\u21b3 DaemonSetStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getChildPods
  • getIndexById
  • getItems
  • getStatuses
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#constructor","title":"constructor","text":"

\u2022 new DaemonSetStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters","title":"Parameters","text":"Name Type dependencies DaemonSetStoreDependencies api DaemonSetApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#overrides","title":"Overrides","text":"

KubeObjectStore<DaemonSet, DaemonSetApi\\>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#api","title":"api","text":"

\u2022 Readonly api: DaemonSetApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: DaemonSet) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_1","title":"Parameters","text":"Name Type item DaemonSet"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: DaemonSetStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#overrides_1","title":"Overrides","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, DaemonSetStatus, DaemonSetSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#items","title":"items","text":"

\u2022 items: IObservableArray<DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<DaemonSet, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_4","title":"Returns","text":"

Generator<DaemonSet, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<DaemonSet, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_6","title":"Returns","text":"

Promise<DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<DaemonSet, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_7","title":"Returns","text":"

Promise<null | DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): DaemonSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_5","title":"Parameters","text":"Name Type items DaemonSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_8","title":"Returns","text":"

DaemonSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): DaemonSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_9","title":"Returns","text":"

DaemonSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | DaemonSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_10","title":"Returns","text":"

undefined | DaemonSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): DaemonSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_11","title":"Returns","text":"

DaemonSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | DaemonSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_12","title":"Returns","text":"

undefined | DaemonSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | DaemonSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_13","title":"Returns","text":"

undefined | DaemonSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getchildpods","title":"getChildPods","text":"

\u25b8 getChildPods(daemonSet): Pod[]

Deprecated

Switch to using getPodsByOwnerId directly

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_11","title":"Parameters","text":"Name Type daemonSet DaemonSet"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_14","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_12","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): DaemonSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_16","title":"Returns","text":"

DaemonSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getstatuses","title":"getStatuses","text":"

\u25b8 getStatuses(daemonSets?): Object

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_13","title":"Parameters","text":"Name Type daemonSets? DaemonSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_17","title":"Returns","text":"

Object

Name Type failed number pending number running number"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_18","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_14","title":"Parameters","text":"Name Type item DaemonSet"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_19","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_15","title":"Parameters","text":"Name Type visibleItems? DaemonSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_20","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#load","title":"load","text":"

\u25b8 load(params): Promise<DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_16","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_21","title":"Returns","text":"

Promise<DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | DaemonSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_17","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_22","title":"Returns","text":"

Promise<undefined | DaemonSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_18","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_23","title":"Returns","text":"

Promise<DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_19","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_24","title":"Returns","text":"

Promise<null | DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<DaemonSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_20","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_25","title":"Returns","text":"

Promise<DaemonSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): DaemonSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_21","title":"Parameters","text":"Name Type partialItems DaemonSet[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_26","title":"Returns","text":"

DaemonSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_22","title":"Parameters","text":"Name Type item DaemonSet patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_27","title":"Returns","text":"

Promise<DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): DaemonSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_23","title":"Parameters","text":"Name Type items DaemonSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_28","title":"Returns","text":"

DaemonSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | DaemonSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_24","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_29","title":"Returns","text":"

Promise<undefined | DaemonSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_25","title":"Parameters","text":"Name Type item DaemonSet"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_26","title":"Parameters","text":"Name Type item DaemonSet request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_27","title":"Parameters","text":"Name Type items DaemonSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_32","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_33","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_28","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_36","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_29","title":"Parameters","text":"Name Type item DaemonSet"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_37","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): DaemonSet[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_30","title":"Parameters","text":"Name Type Description items? DaemonSet[] the items to be sorted (default: the current items in this store) sorting? (item: DaemonSet) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_38","title":"Returns","text":"

DaemonSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_31","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_39","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_32","title":"Parameters","text":"Name Type item DaemonSet"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_33","title":"Parameters","text":"Name Type visibleItems? DaemonSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_41","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_34","title":"Parameters","text":"Name Type item DaemonSet"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_35","title":"Parameters","text":"Name Type item DaemonSet data PartialObjectDeep<DaemonSet, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_43","title":"Returns","text":"

Promise<DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_44","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#parameters_36","title":"Parameters","text":"Name Type item DaemonSet request () => Promise<DaemonSet>"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_45","title":"Returns","text":"

Promise<DaemonSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/","title":"Renderer.K8sApi.DeploymentStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / DeploymentStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#class-deploymentstore","title":"Class: DeploymentStore","text":"

Renderer.K8sApi.DeploymentStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<Deployment, DeploymentApi>

\u21b3 DeploymentStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getChildPods
  • getIndexById
  • getItems
  • getStatuses
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#constructor","title":"constructor","text":"

\u2022 new DeploymentStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters","title":"Parameters","text":"Name Type dependencies DeploymentStoreDependencies api DeploymentApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#overrides","title":"Overrides","text":"

KubeObjectStore<Deployment, DeploymentApi\\>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#api","title":"api","text":"

\u2022 Readonly api: DeploymentApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: Deployment) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_1","title":"Parameters","text":"Name Type item Deployment"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: DeploymentStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#overrides_1","title":"Overrides","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, DeploymentStatus, DeploymentSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#items","title":"items","text":"

\u2022 items: IObservableArray<Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<Deployment, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_4","title":"Returns","text":"

Generator<Deployment, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Deployment, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_6","title":"Returns","text":"

Promise<Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Deployment, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_7","title":"Returns","text":"

Promise<null | Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): Deployment[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_5","title":"Parameters","text":"Name Type items Deployment[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_8","title":"Returns","text":"

Deployment[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): Deployment[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_9","title":"Returns","text":"

Deployment[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | Deployment

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_10","title":"Returns","text":"

undefined | Deployment

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): Deployment[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_11","title":"Returns","text":"

Deployment[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | Deployment

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_12","title":"Returns","text":"

undefined | Deployment

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | Deployment

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_13","title":"Returns","text":"

undefined | Deployment

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getchildpods","title":"getChildPods","text":"

\u25b8 getChildPods(deployment): Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_11","title":"Parameters","text":"Name Type deployment Deployment"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_14","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_12","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): Deployment[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_16","title":"Returns","text":"

Deployment[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getstatuses","title":"getStatuses","text":"

\u25b8 getStatuses(deployments): DeploymentStatuses

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_13","title":"Parameters","text":"Name Type deployments Deployment[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_17","title":"Returns","text":"

DeploymentStatuses

\u25b8 getStatuses(deployments): DeploymentStatuses

Deprecated

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_14","title":"Parameters","text":"Name Type deployments undefined | Deployment[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_18","title":"Returns","text":"

DeploymentStatuses

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_19","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_15","title":"Parameters","text":"Name Type item Deployment"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_20","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_16","title":"Parameters","text":"Name Type visibleItems? Deployment[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_21","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#load","title":"load","text":"

\u25b8 load(params): Promise<Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_22","title":"Returns","text":"

Promise<Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Deployment[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_23","title":"Returns","text":"

Promise<undefined | Deployment[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_19","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_24","title":"Returns","text":"

Promise<Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_20","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_25","title":"Returns","text":"

Promise<null | Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<Deployment[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_21","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_26","title":"Returns","text":"

Promise<Deployment[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Deployment[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_22","title":"Parameters","text":"Name Type partialItems Deployment[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_27","title":"Returns","text":"

Deployment[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_23","title":"Parameters","text":"Name Type item Deployment patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_28","title":"Returns","text":"

Promise<Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): Deployment[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_24","title":"Parameters","text":"Name Type items Deployment[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_29","title":"Returns","text":"

Deployment[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | Deployment[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_25","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_30","title":"Returns","text":"

Promise<undefined | Deployment[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_26","title":"Parameters","text":"Name Type item Deployment"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_27","title":"Parameters","text":"Name Type item Deployment request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_32","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_28","title":"Parameters","text":"Name Type items Deployment[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_33","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_34","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_29","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_36","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_37","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_30","title":"Parameters","text":"Name Type item Deployment"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items): Deployment[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_31","title":"Parameters","text":"Name Type items Deployment[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_39","title":"Returns","text":"

Deployment[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#overrides_2","title":"Overrides","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_32","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_40","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_33","title":"Parameters","text":"Name Type item Deployment"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_41","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_34","title":"Parameters","text":"Name Type visibleItems? Deployment[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_35","title":"Parameters","text":"Name Type item Deployment"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_43","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_36","title":"Parameters","text":"Name Type item Deployment data PartialObjectDeep<Deployment, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_44","title":"Returns","text":"

Promise<Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_45","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#parameters_37","title":"Parameters","text":"Name Type item Deployment request () => Promise<Deployment>"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_46","title":"Returns","text":"

Promise<Deployment>

"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/","title":"Renderer.K8sApi.EndpointStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / EndpointStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#class-endpointstore","title":"Class: EndpointStore","text":"

Renderer.K8sApi.EndpointStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<Endpoint, EndpointsApi, EndpointsData>

\u21b3 EndpointStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#constructor","title":"constructor","text":"

\u2022 new EndpointStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api EndpointsApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<Endpoints, EndpointsApi, EndpointsData>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#api","title":"api","text":"

\u2022 Readonly api: EndpointsApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: Endpoint) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_1","title":"Parameters","text":"Name Type item Endpoint"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<EndpointsData>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#items","title":"items","text":"

\u2022 items: IObservableArray<Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<Endpoint, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_4","title":"Returns","text":"

Generator<Endpoint, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Endpoint, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_6","title":"Returns","text":"

Promise<Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Endpoint, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_7","title":"Returns","text":"

Promise<null | Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): Endpoint[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_5","title":"Parameters","text":"Name Type items Endpoint[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_8","title":"Returns","text":"

Endpoint[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): Endpoint[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_9","title":"Returns","text":"

Endpoint[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | Endpoint

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_10","title":"Returns","text":"

undefined | Endpoint

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): Endpoint[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_11","title":"Returns","text":"

Endpoint[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | Endpoint

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_12","title":"Returns","text":"

undefined | Endpoint

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | Endpoint

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_13","title":"Returns","text":"

undefined | Endpoint

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): Endpoint[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_15","title":"Returns","text":"

Endpoint[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_12","title":"Parameters","text":"Name Type item Endpoint"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? Endpoint[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#load","title":"load","text":"

\u25b8 load(params): Promise<Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_19","title":"Returns","text":"

Promise<Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Endpoint[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_20","title":"Returns","text":"

Promise<undefined | Endpoint[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_21","title":"Returns","text":"

Promise<Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_22","title":"Returns","text":"

Promise<null | Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<Endpoint[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_23","title":"Returns","text":"

Promise<Endpoint[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Endpoint[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_19","title":"Parameters","text":"Name Type partialItems Endpoint[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_24","title":"Returns","text":"

Endpoint[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_20","title":"Parameters","text":"Name Type item Endpoint patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_25","title":"Returns","text":"

Promise<Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): Endpoint[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_21","title":"Parameters","text":"Name Type items Endpoint[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_26","title":"Returns","text":"

Endpoint[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | Endpoint[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_27","title":"Returns","text":"

Promise<undefined | Endpoint[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_23","title":"Parameters","text":"Name Type item Endpoint"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_24","title":"Parameters","text":"Name Type item Endpoint request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_25","title":"Parameters","text":"Name Type items Endpoint[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_27","title":"Parameters","text":"Name Type item Endpoint"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): Endpoint[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_28","title":"Parameters","text":"Name Type Description items? Endpoint[] the items to be sorted (default: the current items in this store) sorting? (item: Endpoint) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_36","title":"Returns","text":"

Endpoint[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_30","title":"Parameters","text":"Name Type item Endpoint"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? Endpoint[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_32","title":"Parameters","text":"Name Type item Endpoint"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_33","title":"Parameters","text":"Name Type item Endpoint data PartialObjectDeep<Endpoint, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_41","title":"Returns","text":"

Promise<Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#parameters_34","title":"Parameters","text":"Name Type item Endpoint request () => Promise<Endpoint>"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_43","title":"Returns","text":"

Promise<Endpoint>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/","title":"Renderer.K8sApi.EventStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / EventStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#class-eventstore","title":"Class: EventStore","text":"

Renderer.K8sApi.EventStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<KubeEvent, KubeEventApi>

\u21b3 EventStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getEventsByObject
  • getIndexById
  • getItems
  • getTotalCount
  • getWarnings
  • getWarningsCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#constructor","title":"constructor","text":"

\u2022 new EventStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters","title":"Parameters","text":"Name Type dependencies EventStoreDependencies api KubeEventApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#overrides","title":"Overrides","text":"

KubeObjectStore<KubeEvent, KubeEventApi\\>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#api","title":"api","text":"

\u2022 Readonly api: KubeEventApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: KubeEvent) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_1","title":"Parameters","text":"Name Type item KubeEvent"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: EventStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#overrides_1","title":"Overrides","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeEventData>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#items","title":"items","text":"

\u2022 items: IObservableArray<KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#limit","title":"limit","text":"

\u2022 Readonly limit: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#overrides_2","title":"Overrides","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<KubeEvent, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_4","title":"Returns","text":"

Generator<KubeEvent, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#overrides_3","title":"Overrides","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_2","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<KubeEvent, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_6","title":"Returns","text":"

Promise<KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<KubeEvent, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_7","title":"Returns","text":"

Promise<null | KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_4","title":"Parameters","text":"Name Type items KubeEvent[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_8","title":"Returns","text":"

KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_5","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_9","title":"Returns","text":"

KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | KubeEvent

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_6","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_10","title":"Returns","text":"

undefined | KubeEvent

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_7","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_11","title":"Returns","text":"

KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | KubeEvent

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_8","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_12","title":"Returns","text":"

undefined | KubeEvent

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | KubeEvent

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_9","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_13","title":"Returns","text":"

undefined | KubeEvent

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#geteventsbyobject","title":"getEventsByObject","text":"

\u25b8 getEventsByObject(obj): KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_10","title":"Parameters","text":"Name Type obj KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_14","title":"Returns","text":"

KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_16","title":"Returns","text":"

KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_17","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getwarnings","title":"getWarnings","text":"

\u25b8 getWarnings(): KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_18","title":"Returns","text":"

KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getwarningscount","title":"getWarningsCount","text":"

\u25b8 getWarningsCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_19","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_12","title":"Parameters","text":"Name Type item KubeEvent"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_20","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? KubeEvent[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_21","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#load","title":"load","text":"

\u25b8 load(params): Promise<KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_22","title":"Returns","text":"

Promise<KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | KubeEvent[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_23","title":"Returns","text":"

Promise<undefined | KubeEvent[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_24","title":"Returns","text":"

Promise<KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_25","title":"Returns","text":"

Promise<null | KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<KubeEvent[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_26","title":"Returns","text":"

Promise<KubeEvent[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_19","title":"Parameters","text":"Name Type partialItems KubeEvent[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_27","title":"Returns","text":"

KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_20","title":"Parameters","text":"Name Type item KubeEvent patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_28","title":"Returns","text":"

Promise<KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_21","title":"Parameters","text":"Name Type items KubeEvent[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_29","title":"Returns","text":"

KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | KubeEvent[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_30","title":"Returns","text":"

Promise<undefined | KubeEvent[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_23","title":"Parameters","text":"Name Type item KubeEvent"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_24","title":"Parameters","text":"Name Type item KubeEvent request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_32","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_25","title":"Parameters","text":"Name Type items KubeEvent[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_33","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_34","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_36","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_37","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_27","title":"Parameters","text":"Name Type item KubeEvent"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items): KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_28","title":"Parameters","text":"Name Type items KubeEvent[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_39","title":"Returns","text":"

KubeEvent[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#overrides_4","title":"Overrides","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_40","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_30","title":"Parameters","text":"Name Type item KubeEvent"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_41","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? KubeEvent[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_32","title":"Parameters","text":"Name Type item KubeEvent"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_43","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_33","title":"Parameters","text":"Name Type item KubeEvent data PartialObjectDeep<KubeEvent, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_44","title":"Returns","text":"

Promise<KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_45","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#parameters_34","title":"Parameters","text":"Name Type item KubeEvent request () => Promise<KubeEvent>"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_46","title":"Returns","text":"

Promise<KubeEvent>

"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/","title":"Renderer.K8sApi.HPAStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / HPAStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#class-hpastore","title":"Class: HPAStore","text":"

Renderer.K8sApi.HPAStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<HorizontalPodAutoscaler, HorizontalPodAutoscalerApi>

\u21b3 HPAStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#constructor","title":"constructor","text":"

\u2022 new HPAStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api HorizontalPodAutoscalerApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<HorizontalPodAutoscaler, HorizontalPodAutoscalerApi>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#api","title":"api","text":"

\u2022 Readonly api: HorizontalPodAutoscalerApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: HorizontalPodAutoscaler) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_1","title":"Parameters","text":"Name Type item HorizontalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, HorizontalPodAutoscalerStatus, HorizontalPodAutoscalerSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#items","title":"items","text":"

\u2022 items: IObservableArray<HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<HorizontalPodAutoscaler, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_4","title":"Returns","text":"

Generator<HorizontalPodAutoscaler, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<HorizontalPodAutoscaler, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_6","title":"Returns","text":"

Promise<HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<HorizontalPodAutoscaler, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_7","title":"Returns","text":"

Promise<null | HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): HorizontalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_5","title":"Parameters","text":"Name Type items HorizontalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_8","title":"Returns","text":"

HorizontalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): HorizontalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_9","title":"Returns","text":"

HorizontalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | HorizontalPodAutoscaler

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_10","title":"Returns","text":"

undefined | HorizontalPodAutoscaler

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): HorizontalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_11","title":"Returns","text":"

HorizontalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | HorizontalPodAutoscaler

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_12","title":"Returns","text":"

undefined | HorizontalPodAutoscaler

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | HorizontalPodAutoscaler

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_13","title":"Returns","text":"

undefined | HorizontalPodAutoscaler

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): HorizontalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_15","title":"Returns","text":"

HorizontalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_12","title":"Parameters","text":"Name Type item HorizontalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? HorizontalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#load","title":"load","text":"

\u25b8 load(params): Promise<HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_19","title":"Returns","text":"

Promise<HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | HorizontalPodAutoscaler[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_20","title":"Returns","text":"

Promise<undefined | HorizontalPodAutoscaler[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_21","title":"Returns","text":"

Promise<HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_22","title":"Returns","text":"

Promise<null | HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<HorizontalPodAutoscaler[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_23","title":"Returns","text":"

Promise<HorizontalPodAutoscaler[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): HorizontalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_19","title":"Parameters","text":"Name Type partialItems HorizontalPodAutoscaler[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_24","title":"Returns","text":"

HorizontalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_20","title":"Parameters","text":"Name Type item HorizontalPodAutoscaler patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_25","title":"Returns","text":"

Promise<HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): HorizontalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_21","title":"Parameters","text":"Name Type items HorizontalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_26","title":"Returns","text":"

HorizontalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | HorizontalPodAutoscaler[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_27","title":"Returns","text":"

Promise<undefined | HorizontalPodAutoscaler[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_23","title":"Parameters","text":"Name Type item HorizontalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_24","title":"Parameters","text":"Name Type item HorizontalPodAutoscaler request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_25","title":"Parameters","text":"Name Type items HorizontalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_27","title":"Parameters","text":"Name Type item HorizontalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): HorizontalPodAutoscaler[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_28","title":"Parameters","text":"Name Type Description items? HorizontalPodAutoscaler[] the items to be sorted (default: the current items in this store) sorting? (item: HorizontalPodAutoscaler) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_36","title":"Returns","text":"

HorizontalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_30","title":"Parameters","text":"Name Type item HorizontalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? HorizontalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_32","title":"Parameters","text":"Name Type item HorizontalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_33","title":"Parameters","text":"Name Type item HorizontalPodAutoscaler data PartialObjectDeep<HorizontalPodAutoscaler, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_41","title":"Returns","text":"

Promise<HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#parameters_34","title":"Parameters","text":"Name Type item HorizontalPodAutoscaler request () => Promise<HorizontalPodAutoscaler>"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_43","title":"Returns","text":"

Promise<HorizontalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/","title":"Renderer.K8sApi.IngressClassStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / IngressClassStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#class-ingressclassstore","title":"Class: IngressClassStore","text":"

Renderer.K8sApi.IngressClassStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<IngressClass, IngressClassApi>

\u21b3 IngressClassStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#constructor","title":"constructor","text":"

\u2022 new IngressClassStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api IngressClassApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<IngressClass, IngressClassApi>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#api","title":"api","text":"

\u2022 Readonly api: IngressClassApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: IngressClass) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_1","title":"Parameters","text":"Name Type item IngressClass"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<ClusterScopedMetadata, IngressClassStatus, IngressClassSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#items","title":"items","text":"

\u2022 items: IObservableArray<IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<IngressClass, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_4","title":"Returns","text":"

Generator<IngressClass, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<IngressClass, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_6","title":"Returns","text":"

Promise<IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<IngressClass, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_7","title":"Returns","text":"

Promise<null | IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): IngressClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_5","title":"Parameters","text":"Name Type items IngressClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_8","title":"Returns","text":"

IngressClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): IngressClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_9","title":"Returns","text":"

IngressClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | IngressClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_10","title":"Returns","text":"

undefined | IngressClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): IngressClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_11","title":"Returns","text":"

IngressClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | IngressClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_12","title":"Returns","text":"

undefined | IngressClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | IngressClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_13","title":"Returns","text":"

undefined | IngressClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): IngressClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_15","title":"Returns","text":"

IngressClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_12","title":"Parameters","text":"Name Type item IngressClass"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? IngressClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#load","title":"load","text":"

\u25b8 load(params): Promise<IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_19","title":"Returns","text":"

Promise<IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | IngressClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_20","title":"Returns","text":"

Promise<undefined | IngressClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_21","title":"Returns","text":"

Promise<IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_22","title":"Returns","text":"

Promise<null | IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<IngressClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_23","title":"Returns","text":"

Promise<IngressClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): IngressClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_19","title":"Parameters","text":"Name Type partialItems IngressClass[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_24","title":"Returns","text":"

IngressClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_20","title":"Parameters","text":"Name Type item IngressClass patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_25","title":"Returns","text":"

Promise<IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): IngressClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_21","title":"Parameters","text":"Name Type items IngressClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_26","title":"Returns","text":"

IngressClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | IngressClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_27","title":"Returns","text":"

Promise<undefined | IngressClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_23","title":"Parameters","text":"Name Type item IngressClass"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_24","title":"Parameters","text":"Name Type item IngressClass request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_25","title":"Parameters","text":"Name Type items IngressClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_27","title":"Parameters","text":"Name Type item IngressClass"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): IngressClass[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_28","title":"Parameters","text":"Name Type Description items? IngressClass[] the items to be sorted (default: the current items in this store) sorting? (item: IngressClass) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_36","title":"Returns","text":"

IngressClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_30","title":"Parameters","text":"Name Type item IngressClass"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? IngressClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_32","title":"Parameters","text":"Name Type item IngressClass"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_33","title":"Parameters","text":"Name Type item IngressClass data PartialObjectDeep<IngressClass, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_41","title":"Returns","text":"

Promise<IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#parameters_34","title":"Parameters","text":"Name Type item IngressClass request () => Promise<IngressClass>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_43","title":"Returns","text":"

Promise<IngressClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/","title":"Renderer.K8sApi.IngressStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / IngressStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#class-ingressstore","title":"Class: IngressStore","text":"

Renderer.K8sApi.IngressStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<Ingress, IngressApi>

\u21b3 IngressStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#constructor","title":"constructor","text":"

\u2022 new IngressStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api IngressApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<Ingress, IngressApi>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#api","title":"api","text":"

\u2022 Readonly api: IngressApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: Ingress) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_1","title":"Parameters","text":"Name Type item Ingress"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, IngressStatus, IngressSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#items","title":"items","text":"

\u2022 items: IObservableArray<Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<Ingress, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_4","title":"Returns","text":"

Generator<Ingress, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Ingress, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_6","title":"Returns","text":"

Promise<Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Ingress, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_7","title":"Returns","text":"

Promise<null | Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): Ingress[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_5","title":"Parameters","text":"Name Type items Ingress[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_8","title":"Returns","text":"

Ingress[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): Ingress[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_9","title":"Returns","text":"

Ingress[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | Ingress

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_10","title":"Returns","text":"

undefined | Ingress

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): Ingress[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_11","title":"Returns","text":"

Ingress[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | Ingress

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_12","title":"Returns","text":"

undefined | Ingress

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | Ingress

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_13","title":"Returns","text":"

undefined | Ingress

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): Ingress[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_15","title":"Returns","text":"

Ingress[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_12","title":"Parameters","text":"Name Type item Ingress"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? Ingress[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#load","title":"load","text":"

\u25b8 load(params): Promise<Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_19","title":"Returns","text":"

Promise<Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Ingress[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_20","title":"Returns","text":"

Promise<undefined | Ingress[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_21","title":"Returns","text":"

Promise<Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_22","title":"Returns","text":"

Promise<null | Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<Ingress[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_23","title":"Returns","text":"

Promise<Ingress[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Ingress[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_19","title":"Parameters","text":"Name Type partialItems Ingress[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_24","title":"Returns","text":"

Ingress[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_20","title":"Parameters","text":"Name Type item Ingress patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_25","title":"Returns","text":"

Promise<Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): Ingress[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_21","title":"Parameters","text":"Name Type items Ingress[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_26","title":"Returns","text":"

Ingress[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | Ingress[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_27","title":"Returns","text":"

Promise<undefined | Ingress[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_23","title":"Parameters","text":"Name Type item Ingress"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_24","title":"Parameters","text":"Name Type item Ingress request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_25","title":"Parameters","text":"Name Type items Ingress[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_27","title":"Parameters","text":"Name Type item Ingress"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): Ingress[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_28","title":"Parameters","text":"Name Type Description items? Ingress[] the items to be sorted (default: the current items in this store) sorting? (item: Ingress) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_36","title":"Returns","text":"

Ingress[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_30","title":"Parameters","text":"Name Type item Ingress"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? Ingress[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_32","title":"Parameters","text":"Name Type item Ingress"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_33","title":"Parameters","text":"Name Type item Ingress data PartialObjectDeep<Ingress, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_41","title":"Returns","text":"

Promise<Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#parameters_34","title":"Parameters","text":"Name Type item Ingress request () => Promise<Ingress>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_43","title":"Returns","text":"

Promise<Ingress>

"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/","title":"Renderer.K8sApi.JobStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / JobStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#class-jobstore","title":"Class: JobStore","text":"

Renderer.K8sApi.JobStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<Job, JobApi>

\u21b3 JobStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getChildPods
  • getIndexById
  • getItems
  • getJobsByOwner
  • getStatuses
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#constructor","title":"constructor","text":"

\u2022 new JobStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters","title":"Parameters","text":"Name Type dependencies Dependencies api JobApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#overrides","title":"Overrides","text":"

KubeObjectStore<Job, JobApi\\>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#api","title":"api","text":"

\u2022 Readonly api: JobApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: Job) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_1","title":"Parameters","text":"Name Type item Job"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: Dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#overrides_1","title":"Overrides","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, JobStatus, JobSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#items","title":"items","text":"

\u2022 items: IObservableArray<Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<Job, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_4","title":"Returns","text":"

Generator<Job, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Job, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_6","title":"Returns","text":"

Promise<Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Job, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_7","title":"Returns","text":"

Promise<null | Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_5","title":"Parameters","text":"Name Type items Job[]"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_8","title":"Returns","text":"

Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_9","title":"Returns","text":"

Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | Job

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_10","title":"Returns","text":"

undefined | Job

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_11","title":"Returns","text":"

Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | Job

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_12","title":"Returns","text":"

undefined | Job

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | Job

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_13","title":"Returns","text":"

undefined | Job

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getchildpods","title":"getChildPods","text":"

\u25b8 getChildPods(job): Pod[]

Deprecated

Switch to using getPodsByOwnerId directly

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_11","title":"Parameters","text":"Name Type job Job"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_14","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_12","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_16","title":"Returns","text":"

Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getjobsbyowner","title":"getJobsByOwner","text":"

\u25b8 getJobsByOwner(cronJob): Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_13","title":"Parameters","text":"Name Type cronJob CronJob"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_17","title":"Returns","text":"

Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getstatuses","title":"getStatuses","text":"

\u25b8 getStatuses(jobs?): Object

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_14","title":"Parameters","text":"Name Type jobs? Job[]"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_18","title":"Returns","text":"

Object

Name Type failed number pending number running number succeeded number"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_19","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_15","title":"Parameters","text":"Name Type item Job"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_20","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_16","title":"Parameters","text":"Name Type visibleItems? Job[]"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_21","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#load","title":"load","text":"

\u25b8 load(params): Promise<Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_22","title":"Returns","text":"

Promise<Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Job[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_23","title":"Returns","text":"

Promise<undefined | Job[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_19","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_24","title":"Returns","text":"

Promise<Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_20","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_25","title":"Returns","text":"

Promise<null | Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<Job[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_21","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_26","title":"Returns","text":"

Promise<Job[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_22","title":"Parameters","text":"Name Type partialItems Job[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_27","title":"Returns","text":"

Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_23","title":"Parameters","text":"Name Type item Job patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_28","title":"Returns","text":"

Promise<Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_24","title":"Parameters","text":"Name Type items Job[]"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_29","title":"Returns","text":"

Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | Job[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_25","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_30","title":"Returns","text":"

Promise<undefined | Job[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_26","title":"Parameters","text":"Name Type item Job"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_27","title":"Parameters","text":"Name Type item Job request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_32","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_28","title":"Parameters","text":"Name Type items Job[]"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_33","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_34","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_29","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_36","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_37","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_30","title":"Parameters","text":"Name Type item Job"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): Job[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_31","title":"Parameters","text":"Name Type Description items? Job[] the items to be sorted (default: the current items in this store) sorting? (item: Job) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_39","title":"Returns","text":"

Job[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_32","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_40","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_33","title":"Parameters","text":"Name Type item Job"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_41","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_34","title":"Parameters","text":"Name Type visibleItems? Job[]"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_35","title":"Parameters","text":"Name Type item Job"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_43","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_36","title":"Parameters","text":"Name Type item Job data PartialObjectDeep<Job, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_44","title":"Returns","text":"

Promise<Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_45","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#parameters_37","title":"Parameters","text":"Name Type item Job request () => Promise<Job>"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_46","title":"Returns","text":"

Promise<Job>

"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/","title":"Renderer.K8sApi.LimitRangesStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / LimitRangesStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#class-limitrangesstore","title":"Class: LimitRangesStore","text":"

Renderer.K8sApi.LimitRangesStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<LimitRange, LimitRangeApi>

\u21b3 LimitRangesStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#constructor","title":"constructor","text":"

\u2022 new LimitRangesStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api LimitRangeApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<LimitRange, LimitRangeApi>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#api","title":"api","text":"

\u2022 Readonly api: LimitRangeApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: LimitRange) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_1","title":"Parameters","text":"Name Type item LimitRange"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, void, LimitRangeSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#items","title":"items","text":"

\u2022 items: IObservableArray<LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<LimitRange, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_4","title":"Returns","text":"

Generator<LimitRange, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<LimitRange, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_6","title":"Returns","text":"

Promise<LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<LimitRange, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_7","title":"Returns","text":"

Promise<null | LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): LimitRange[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_5","title":"Parameters","text":"Name Type items LimitRange[]"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_8","title":"Returns","text":"

LimitRange[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): LimitRange[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_9","title":"Returns","text":"

LimitRange[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | LimitRange

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_10","title":"Returns","text":"

undefined | LimitRange

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): LimitRange[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_11","title":"Returns","text":"

LimitRange[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | LimitRange

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_12","title":"Returns","text":"

undefined | LimitRange

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | LimitRange

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_13","title":"Returns","text":"

undefined | LimitRange

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): LimitRange[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_15","title":"Returns","text":"

LimitRange[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_12","title":"Parameters","text":"Name Type item LimitRange"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? LimitRange[]"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#load","title":"load","text":"

\u25b8 load(params): Promise<LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_19","title":"Returns","text":"

Promise<LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | LimitRange[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_20","title":"Returns","text":"

Promise<undefined | LimitRange[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_21","title":"Returns","text":"

Promise<LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_22","title":"Returns","text":"

Promise<null | LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<LimitRange[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_23","title":"Returns","text":"

Promise<LimitRange[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): LimitRange[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_19","title":"Parameters","text":"Name Type partialItems LimitRange[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_24","title":"Returns","text":"

LimitRange[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_20","title":"Parameters","text":"Name Type item LimitRange patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_25","title":"Returns","text":"

Promise<LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): LimitRange[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_21","title":"Parameters","text":"Name Type items LimitRange[]"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_26","title":"Returns","text":"

LimitRange[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | LimitRange[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_27","title":"Returns","text":"

Promise<undefined | LimitRange[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_23","title":"Parameters","text":"Name Type item LimitRange"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_24","title":"Parameters","text":"Name Type item LimitRange request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_25","title":"Parameters","text":"Name Type items LimitRange[]"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_27","title":"Parameters","text":"Name Type item LimitRange"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): LimitRange[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_28","title":"Parameters","text":"Name Type Description items? LimitRange[] the items to be sorted (default: the current items in this store) sorting? (item: LimitRange) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_36","title":"Returns","text":"

LimitRange[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_30","title":"Parameters","text":"Name Type item LimitRange"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? LimitRange[]"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_32","title":"Parameters","text":"Name Type item LimitRange"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_33","title":"Parameters","text":"Name Type item LimitRange data PartialObjectDeep<LimitRange, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_41","title":"Returns","text":"

Promise<LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#parameters_34","title":"Parameters","text":"Name Type item LimitRange request () => Promise<LimitRange>"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_43","title":"Returns","text":"

Promise<LimitRange>

"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/","title":"Renderer.K8sApi.NamespaceStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / NamespaceStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#class-namespacestore","title":"Class: NamespaceStore","text":"

Renderer.K8sApi.NamespaceStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<Namespace, NamespaceApi>

\u21b3 NamespaceStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectNamespaces
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#accessors","title":"Accessors","text":"
  • allowedNamespaces
  • areAllSelectedImplicitly
  • contextItems
  • contextNamespaces
  • hasAllContexts
  • query
  • selectedItems
  • selectedNames
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • clearSelected
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getNamespaceTree
  • getTotalCount
  • hasContext
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • onContextChange
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • selectAll
  • selectSingle
  • sortItems
  • subscribe
  • toggleAll
  • toggleContext
  • toggleSelection
  • toggleSelectionAll
  • toggleSingle
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#constructor","title":"constructor","text":"

\u2022 new NamespaceStore(dependencies, api)

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters","title":"Parameters","text":"Name Type dependencies Dependencies api NamespaceApi"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#overrides","title":"Overrides","text":"

KubeObjectStore<Namespace, NamespaceApi\\>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#api","title":"api","text":"

\u2022 Readonly api: NamespaceApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: Namespace) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_1","title":"Parameters","text":"Name Type item Namespace"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: Dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#overrides_1","title":"Overrides","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<ClusterScopedMetadata, NamespaceStatus, NamespaceSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#items","title":"items","text":"

\u2022 items: IObservableArray<Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selectnamespaces","title":"selectNamespaces","text":"

\u2022 selectNamespaces: (namespace: string | string[]) => void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (namespace): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_2","title":"Parameters","text":"Name Type namespace string | string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#allowednamespaces","title":"allowedNamespaces","text":"

\u2022 get allowedNamespaces(): string[]

Deprecated

This doesn't contain the namespaces from cluster settings or from cluster context

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_2","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#areallselectedimplicitly","title":"areAllSelectedImplicitly","text":"

\u2022 get areAllSelectedImplicitly(): boolean

Is true when the the set of namespace names selected is implicitly all

Namely, this will be true if the user has deselected all namespaces from the filter or if the user has clicked the \"All Namespaces\" option

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_3","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_4","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#contextnamespaces","title":"contextNamespaces","text":"

\u2022 get contextNamespaces(): string[]

The list of selected namespace names (for filtering)

Deprecated

This doesn't contain the namespaces from cluster settings or from cluster context

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_5","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#hasallcontexts","title":"hasAllContexts","text":"

\u2022 get hasAllContexts(): boolean

Is true if all available namespaces are selected, otherwise false

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_6","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_7","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_8","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selectednames","title":"selectedNames","text":"

\u2022 get selectedNames(): Set<string>

The set of select namespace names (for filtering)

Deprecated

This doesn't contain the namespaces from cluster settings or from cluster context

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_9","title":"Returns","text":"

Set<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<Namespace, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_10","title":"Returns","text":"

Generator<Namespace, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_3","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_11","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#clearselected","title":"clearSelected","text":"

\u25b8 clearSelected(namespaces?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_4","title":"Parameters","text":"Name Type namespaces? string | string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_12","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_5","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Namespace, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_13","title":"Returns","text":"

Promise<Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_6","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Namespace, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_14","title":"Returns","text":"

Promise<null | Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): Namespace[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_7","title":"Parameters","text":"Name Type items Namespace[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_15","title":"Returns","text":"

Namespace[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): Namespace[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_8","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_16","title":"Returns","text":"

Namespace[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | Namespace

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_9","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_17","title":"Returns","text":"

undefined | Namespace

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): Namespace[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_10","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_18","title":"Returns","text":"

Namespace[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | Namespace

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_11","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_19","title":"Returns","text":"

undefined | Namespace

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | Namespace

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_12","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_20","title":"Returns","text":"

undefined | Namespace

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_13","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_21","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): Namespace[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_22","title":"Returns","text":"

Namespace[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getnamespacetree","title":"getNamespaceTree","text":"

\u25b8 getNamespaceTree(root): NamespaceTree

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_14","title":"Parameters","text":"Name Type root Namespace"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_23","title":"Returns","text":"

NamespaceTree

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_24","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#hascontext","title":"hasContext","text":"

\u25b8 hasContext(namespaces): boolean

Checks if namespace names are selected for filtering

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_15","title":"Parameters","text":"Name Type Description namespaces string | string[] One or several names of namespaces to check if they are selected"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_25","title":"Returns","text":"

boolean

true if all the provided names are selected

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_16","title":"Parameters","text":"Name Type item Namespace"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_26","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_17","title":"Parameters","text":"Name Type visibleItems? Namespace[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_27","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#load","title":"load","text":"

\u25b8 load(params): Promise<Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_18","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_28","title":"Returns","text":"

Promise<Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Namespace[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_19","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_29","title":"Returns","text":"

Promise<undefined | Namespace[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_20","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_30","title":"Returns","text":"

Promise<Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_21","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_31","title":"Returns","text":"

Promise<null | Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(params): Promise<Namespace[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_22","title":"Parameters","text":"Name Type params KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_32","title":"Returns","text":"

Promise<Namespace[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#overrides_2","title":"Overrides","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Namespace[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_23","title":"Parameters","text":"Name Type partialItems Namespace[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_33","title":"Returns","text":"

Namespace[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#oncontextchange","title":"onContextChange","text":"

\u25b8 onContextChange(callback, opts?): IReactionDisposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_24","title":"Parameters","text":"Name Type callback (namespaces: string[]) => void opts? Object opts.fireImmediately? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_34","title":"Returns","text":"

IReactionDisposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_25","title":"Parameters","text":"Name Type item Namespace patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_35","title":"Returns","text":"

Promise<Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): Namespace[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_26","title":"Parameters","text":"Name Type items Namespace[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_36","title":"Returns","text":"

Namespace[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | Namespace[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_27","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_37","title":"Returns","text":"

Promise<undefined | Namespace[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_28","title":"Parameters","text":"Name Type item Namespace"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_38","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#overrides_3","title":"Overrides","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_29","title":"Parameters","text":"Name Type item Namespace request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_39","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_30","title":"Parameters","text":"Name Type items Namespace[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_40","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_41","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_31","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_43","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_44","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_32","title":"Parameters","text":"Name Type item Namespace"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_45","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selectall","title":"selectAll","text":"

\u25b8 selectAll(): void

Selects all available namespaces.

Note: If new namespaces appear in the future those will be selected too

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_46","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selectsingle","title":"selectSingle","text":"

\u25b8 selectSingle(namespace): void

Makes the given namespace the sole selected namespace

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_33","title":"Parameters","text":"Name Type namespace string"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_47","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): Namespace[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_34","title":"Parameters","text":"Name Type Description items? Namespace[] the items to be sorted (default: the current items in this store) sorting? (item: Namespace) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_48","title":"Returns","text":"

Namespace[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(): (...args: T) => void"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_49","title":"Returns","text":"

fn

\u25b8 <T>(...args): void

A function that does nothing

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#type-parameters","title":"Type parameters","text":"Name Type T extends any[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_35","title":"Parameters","text":"Name Type ...args T"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_50","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#overrides_4","title":"Overrides","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#toggleall","title":"toggleAll","text":"

\u25b8 toggleAll(selectAll?): void

This function selects all namespaces implicitly.

NOTE: does not toggle any namespaces

Deprecated

Use NamespaceStore.selectAll instead.

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_36","title":"Parameters","text":"Name Type Description selectAll? boolean NOT USED"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_51","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#togglecontext","title":"toggleContext","text":"

\u25b8 toggleContext(namespaces): void

Acts like toggleSingle but can work on several at a time

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_37","title":"Parameters","text":"Name Type Description namespaces string | string[] One or many names of namespaces to select"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_52","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_38","title":"Parameters","text":"Name Type item Namespace"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_53","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_39","title":"Parameters","text":"Name Type visibleItems? Namespace[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_54","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#togglesingle","title":"toggleSingle","text":"

\u25b8 toggleSingle(namespace): void

Toggles the selection state of namespace. Namely, if it was previously specifically or implicitly selected then after this call it will be explicitly deselected.

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_40","title":"Parameters","text":"Name Type Description namespace string The name of a namespace"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_55","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_41","title":"Parameters","text":"Name Type item Namespace"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_56","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_42","title":"Parameters","text":"Name Type item Namespace data PartialObjectDeep<Namespace, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_57","title":"Returns","text":"

Promise<Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_58","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_43","title":"Parameters","text":"Name Type item Namespace request () => Promise<Namespace>"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_59","title":"Returns","text":"

Promise<Namespace>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/","title":"Renderer.K8sApi.NetworkPolicyStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / NetworkPolicyStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#class-networkpolicystore","title":"Class: NetworkPolicyStore","text":"

Renderer.K8sApi.NetworkPolicyStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<NetworkPolicy, NetworkPolicyApi>

\u21b3 NetworkPolicyStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#constructor","title":"constructor","text":"

\u2022 new NetworkPolicyStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api NetworkPolicyApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<NetworkPolicy, NetworkPolicyApi>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#api","title":"api","text":"

\u2022 Readonly api: NetworkPolicyApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: NetworkPolicy) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_1","title":"Parameters","text":"Name Type item NetworkPolicy"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, void, NetworkPolicySpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#items","title":"items","text":"

\u2022 items: IObservableArray<NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<NetworkPolicy, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_4","title":"Returns","text":"

Generator<NetworkPolicy, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<NetworkPolicy, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_6","title":"Returns","text":"

Promise<NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<NetworkPolicy, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_7","title":"Returns","text":"

Promise<null | NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): NetworkPolicy[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_5","title":"Parameters","text":"Name Type items NetworkPolicy[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_8","title":"Returns","text":"

NetworkPolicy[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): NetworkPolicy[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_9","title":"Returns","text":"

NetworkPolicy[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | NetworkPolicy

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_10","title":"Returns","text":"

undefined | NetworkPolicy

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): NetworkPolicy[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_11","title":"Returns","text":"

NetworkPolicy[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | NetworkPolicy

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_12","title":"Returns","text":"

undefined | NetworkPolicy

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | NetworkPolicy

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_13","title":"Returns","text":"

undefined | NetworkPolicy

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): NetworkPolicy[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_15","title":"Returns","text":"

NetworkPolicy[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_12","title":"Parameters","text":"Name Type item NetworkPolicy"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? NetworkPolicy[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#load","title":"load","text":"

\u25b8 load(params): Promise<NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_19","title":"Returns","text":"

Promise<NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | NetworkPolicy[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_20","title":"Returns","text":"

Promise<undefined | NetworkPolicy[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_21","title":"Returns","text":"

Promise<NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_22","title":"Returns","text":"

Promise<null | NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<NetworkPolicy[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_23","title":"Returns","text":"

Promise<NetworkPolicy[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): NetworkPolicy[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_19","title":"Parameters","text":"Name Type partialItems NetworkPolicy[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_24","title":"Returns","text":"

NetworkPolicy[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_20","title":"Parameters","text":"Name Type item NetworkPolicy patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_25","title":"Returns","text":"

Promise<NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): NetworkPolicy[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_21","title":"Parameters","text":"Name Type items NetworkPolicy[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_26","title":"Returns","text":"

NetworkPolicy[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | NetworkPolicy[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_27","title":"Returns","text":"

Promise<undefined | NetworkPolicy[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_23","title":"Parameters","text":"Name Type item NetworkPolicy"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_24","title":"Parameters","text":"Name Type item NetworkPolicy request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_25","title":"Parameters","text":"Name Type items NetworkPolicy[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_27","title":"Parameters","text":"Name Type item NetworkPolicy"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): NetworkPolicy[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_28","title":"Parameters","text":"Name Type Description items? NetworkPolicy[] the items to be sorted (default: the current items in this store) sorting? (item: NetworkPolicy) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_36","title":"Returns","text":"

NetworkPolicy[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_30","title":"Parameters","text":"Name Type item NetworkPolicy"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? NetworkPolicy[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_32","title":"Parameters","text":"Name Type item NetworkPolicy"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_33","title":"Parameters","text":"Name Type item NetworkPolicy data PartialObjectDeep<NetworkPolicy, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_41","title":"Returns","text":"

Promise<NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#parameters_34","title":"Parameters","text":"Name Type item NetworkPolicy request () => Promise<NetworkPolicy>"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_43","title":"Returns","text":"

Promise<NetworkPolicy>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/","title":"Renderer.K8sApi.NodesStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / NodesStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#class-nodesstore","title":"Class: NodesStore","text":"

Renderer.K8sApi.NodesStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<Node, NodeApi>

\u21b3 NodesStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#accessors","title":"Accessors","text":"
  • contextItems
  • masterNodes
  • query
  • selectedItems
  • workerNodes
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • getWarningsCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#constructor","title":"constructor","text":"

\u2022 new NodesStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api NodeApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#overrides","title":"Overrides","text":"

KubeObjectStore<Node, NodeApi\\>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#api","title":"api","text":"

\u2022 Readonly api: NodeApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: Node) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_1","title":"Parameters","text":"Name Type item Node"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<ClusterScopedMetadata, NodeStatus, NodeSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#items","title":"items","text":"

\u2022 items: IObservableArray<Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#masternodes","title":"masterNodes","text":"

\u2022 get masterNodes(): Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_2","title":"Returns","text":"

Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_3","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_4","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#workernodes","title":"workerNodes","text":"

\u2022 get workerNodes(): Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_5","title":"Returns","text":"

Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<Node, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_6","title":"Returns","text":"

Generator<Node, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_7","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Node, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_8","title":"Returns","text":"

Promise<Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Node, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_9","title":"Returns","text":"

Promise<null | Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_5","title":"Parameters","text":"Name Type items Node[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_10","title":"Returns","text":"

Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_11","title":"Returns","text":"

Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | Node

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_12","title":"Returns","text":"

undefined | Node

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_13","title":"Returns","text":"

Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | Node

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_14","title":"Returns","text":"

undefined | Node

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | Node

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_15","title":"Returns","text":"

undefined | Node

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_17","title":"Returns","text":"

Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_18","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getwarningscount","title":"getWarningsCount","text":"

\u25b8 getWarningsCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_19","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_12","title":"Parameters","text":"Name Type item Node"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_20","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? Node[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_21","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#load","title":"load","text":"

\u25b8 load(params): Promise<Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_22","title":"Returns","text":"

Promise<Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Node[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_23","title":"Returns","text":"

Promise<undefined | Node[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_24","title":"Returns","text":"

Promise<Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_25","title":"Returns","text":"

Promise<null | Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<Node[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_26","title":"Returns","text":"

Promise<Node[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_19","title":"Parameters","text":"Name Type partialItems Node[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_27","title":"Returns","text":"

Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_20","title":"Parameters","text":"Name Type item Node patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_28","title":"Returns","text":"

Promise<Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_21","title":"Parameters","text":"Name Type items Node[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_29","title":"Returns","text":"

Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | Node[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_30","title":"Returns","text":"

Promise<undefined | Node[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_23","title":"Parameters","text":"Name Type item Node"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_24","title":"Parameters","text":"Name Type item Node request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_32","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_25","title":"Parameters","text":"Name Type items Node[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_33","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_34","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_36","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_37","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_27","title":"Parameters","text":"Name Type item Node"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): Node[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_28","title":"Parameters","text":"Name Type Description items? Node[] the items to be sorted (default: the current items in this store) sorting? (item: Node) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_39","title":"Returns","text":"

Node[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_40","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_30","title":"Parameters","text":"Name Type item Node"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_41","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? Node[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_32","title":"Parameters","text":"Name Type item Node"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_43","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_33","title":"Parameters","text":"Name Type item Node data PartialObjectDeep<Node, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_44","title":"Returns","text":"

Promise<Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_45","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#parameters_34","title":"Parameters","text":"Name Type item Node request () => Promise<Node>"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_46","title":"Returns","text":"

Promise<Node>

"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/","title":"Renderer.K8sApi.PersistentVolumesStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / PersistentVolumesStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#class-persistentvolumesstore","title":"Class: PersistentVolumesStore","text":"

Renderer.K8sApi.PersistentVolumesStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<PersistentVolume, PersistentVolumeApi>

\u21b3 PersistentVolumesStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getByStorageClass
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#constructor","title":"constructor","text":"

\u2022 new PersistentVolumesStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api PersistentVolumeApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<PersistentVolume, PersistentVolumeApi>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#api","title":"api","text":"

\u2022 Readonly api: PersistentVolumeApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: PersistentVolume) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_1","title":"Parameters","text":"Name Type item PersistentVolume"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<ClusterScopedMetadata, PersistentVolumeStatus, PersistentVolumeSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#items","title":"items","text":"

\u2022 items: IObservableArray<PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<PersistentVolume, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_4","title":"Returns","text":"

Generator<PersistentVolume, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<PersistentVolume, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_6","title":"Returns","text":"

Promise<PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<PersistentVolume, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_7","title":"Returns","text":"

Promise<null | PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_5","title":"Parameters","text":"Name Type items PersistentVolume[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_8","title":"Returns","text":"

PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_9","title":"Returns","text":"

PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | PersistentVolume

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_10","title":"Returns","text":"

undefined | PersistentVolume

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_11","title":"Returns","text":"

PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | PersistentVolume

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_12","title":"Returns","text":"

undefined | PersistentVolume

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | PersistentVolume

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_13","title":"Returns","text":"

undefined | PersistentVolume

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getbystorageclass","title":"getByStorageClass","text":"

\u25b8 getByStorageClass(storageClass): PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_11","title":"Parameters","text":"Name Type storageClass StorageClass"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_14","title":"Returns","text":"

PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_12","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_16","title":"Returns","text":"

PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_17","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_13","title":"Parameters","text":"Name Type item PersistentVolume"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_14","title":"Parameters","text":"Name Type visibleItems? PersistentVolume[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_19","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#load","title":"load","text":"

\u25b8 load(params): Promise<PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_15","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_20","title":"Returns","text":"

Promise<PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | PersistentVolume[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_16","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_21","title":"Returns","text":"

Promise<undefined | PersistentVolume[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_17","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_22","title":"Returns","text":"

Promise<PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_18","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_23","title":"Returns","text":"

Promise<null | PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<PersistentVolume[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_19","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_24","title":"Returns","text":"

Promise<PersistentVolume[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_20","title":"Parameters","text":"Name Type partialItems PersistentVolume[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_25","title":"Returns","text":"

PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_21","title":"Parameters","text":"Name Type item PersistentVolume patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_26","title":"Returns","text":"

Promise<PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_22","title":"Parameters","text":"Name Type items PersistentVolume[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_27","title":"Returns","text":"

PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | PersistentVolume[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_23","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_28","title":"Returns","text":"

Promise<undefined | PersistentVolume[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_24","title":"Parameters","text":"Name Type item PersistentVolume"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_25","title":"Parameters","text":"Name Type item PersistentVolume request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_26","title":"Parameters","text":"Name Type items PersistentVolume[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_32","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_27","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_28","title":"Parameters","text":"Name Type item PersistentVolume"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_36","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): PersistentVolume[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_29","title":"Parameters","text":"Name Type Description items? PersistentVolume[] the items to be sorted (default: the current items in this store) sorting? (item: PersistentVolume) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_37","title":"Returns","text":"

PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_30","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_38","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_31","title":"Parameters","text":"Name Type item PersistentVolume"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_32","title":"Parameters","text":"Name Type visibleItems? PersistentVolume[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_33","title":"Parameters","text":"Name Type item PersistentVolume"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_41","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_34","title":"Parameters","text":"Name Type item PersistentVolume data PartialObjectDeep<PersistentVolume, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_42","title":"Returns","text":"

Promise<PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_43","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#parameters_35","title":"Parameters","text":"Name Type item PersistentVolume request () => Promise<PersistentVolume>"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_44","title":"Returns","text":"

Promise<PersistentVolume>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/","title":"Renderer.K8sApi.PodDisruptionBudgetsStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / PodDisruptionBudgetsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#class-poddisruptionbudgetsstore","title":"Class: PodDisruptionBudgetsStore","text":"

Renderer.K8sApi.PodDisruptionBudgetsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<PodDisruptionBudget, PodDisruptionBudgetApi>

\u21b3 PodDisruptionBudgetsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#constructor","title":"constructor","text":"

\u2022 new PodDisruptionBudgetsStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api PodDisruptionBudgetApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<PodDisruptionBudget, PodDisruptionBudgetApi>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#api","title":"api","text":"

\u2022 Readonly api: PodDisruptionBudgetApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: PodDisruptionBudget) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_1","title":"Parameters","text":"Name Type item PodDisruptionBudget"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, V1Beta1PodDisruptionBudgetStatus | V1PodDisruptionBudgetStatus, PodDisruptionBudgetSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#items","title":"items","text":"

\u2022 items: IObservableArray<PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<PodDisruptionBudget, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_4","title":"Returns","text":"

Generator<PodDisruptionBudget, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<PodDisruptionBudget, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_6","title":"Returns","text":"

Promise<PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<PodDisruptionBudget, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_7","title":"Returns","text":"

Promise<null | PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): PodDisruptionBudget[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_5","title":"Parameters","text":"Name Type items PodDisruptionBudget[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_8","title":"Returns","text":"

PodDisruptionBudget[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): PodDisruptionBudget[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_9","title":"Returns","text":"

PodDisruptionBudget[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | PodDisruptionBudget

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_10","title":"Returns","text":"

undefined | PodDisruptionBudget

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): PodDisruptionBudget[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_11","title":"Returns","text":"

PodDisruptionBudget[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | PodDisruptionBudget

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_12","title":"Returns","text":"

undefined | PodDisruptionBudget

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | PodDisruptionBudget

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_13","title":"Returns","text":"

undefined | PodDisruptionBudget

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): PodDisruptionBudget[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_15","title":"Returns","text":"

PodDisruptionBudget[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_12","title":"Parameters","text":"Name Type item PodDisruptionBudget"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? PodDisruptionBudget[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#load","title":"load","text":"

\u25b8 load(params): Promise<PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_19","title":"Returns","text":"

Promise<PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | PodDisruptionBudget[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_20","title":"Returns","text":"

Promise<undefined | PodDisruptionBudget[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_21","title":"Returns","text":"

Promise<PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_22","title":"Returns","text":"

Promise<null | PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<PodDisruptionBudget[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_23","title":"Returns","text":"

Promise<PodDisruptionBudget[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): PodDisruptionBudget[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_19","title":"Parameters","text":"Name Type partialItems PodDisruptionBudget[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_24","title":"Returns","text":"

PodDisruptionBudget[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_20","title":"Parameters","text":"Name Type item PodDisruptionBudget patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_25","title":"Returns","text":"

Promise<PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): PodDisruptionBudget[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_21","title":"Parameters","text":"Name Type items PodDisruptionBudget[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_26","title":"Returns","text":"

PodDisruptionBudget[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | PodDisruptionBudget[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_27","title":"Returns","text":"

Promise<undefined | PodDisruptionBudget[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_23","title":"Parameters","text":"Name Type item PodDisruptionBudget"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_24","title":"Parameters","text":"Name Type item PodDisruptionBudget request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_25","title":"Parameters","text":"Name Type items PodDisruptionBudget[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_27","title":"Parameters","text":"Name Type item PodDisruptionBudget"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): PodDisruptionBudget[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_28","title":"Parameters","text":"Name Type Description items? PodDisruptionBudget[] the items to be sorted (default: the current items in this store) sorting? (item: PodDisruptionBudget) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_36","title":"Returns","text":"

PodDisruptionBudget[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_30","title":"Parameters","text":"Name Type item PodDisruptionBudget"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? PodDisruptionBudget[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_32","title":"Parameters","text":"Name Type item PodDisruptionBudget"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_33","title":"Parameters","text":"Name Type item PodDisruptionBudget data PartialObjectDeep<PodDisruptionBudget, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_41","title":"Returns","text":"

Promise<PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#parameters_34","title":"Parameters","text":"Name Type item PodDisruptionBudget request () => Promise<PodDisruptionBudget>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_43","title":"Returns","text":"

Promise<PodDisruptionBudget>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/","title":"Renderer.K8sApi.PodsStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / PodsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#class-podsstore","title":"Class: PodsStore","text":"

Renderer.K8sApi.PodsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<Pod, PodApi>

\u21b3 PodsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • kubeMetrics
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getPodKubeMetrics
  • getPodsByNode
  • getPodsByOwner
  • getPodsByOwnerId
  • getStatuses
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • loadKubeMetrics
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#constructor","title":"constructor","text":"

\u2022 new PodsStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters","title":"Parameters","text":"Name Type dependencies PodStoreDependencies api PodApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#overrides","title":"Overrides","text":"

KubeObjectStore<Pod, PodApi\\>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#api","title":"api","text":"

\u2022 Readonly api: PodApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: Pod) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_1","title":"Parameters","text":"Name Type item Pod"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: PodStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#overrides_1","title":"Overrides","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, PodStatus, PodSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#items","title":"items","text":"

\u2022 items: IObservableArray<Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#kubemetrics","title":"kubeMetrics","text":"

\u2022 Readonly kubeMetrics: IObservableArray<PodMetrics>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<Pod, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_4","title":"Returns","text":"

Generator<Pod, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Pod, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_6","title":"Returns","text":"

Promise<Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Pod, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_7","title":"Returns","text":"

Promise<null | Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_5","title":"Parameters","text":"Name Type items Pod[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_8","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_9","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | Pod

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_10","title":"Returns","text":"

undefined | Pod

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_11","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | Pod

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_12","title":"Returns","text":"

undefined | Pod

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | Pod

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_13","title":"Returns","text":"

undefined | Pod

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_15","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getpodkubemetrics","title":"getPodKubeMetrics","text":"

\u25b8 getPodKubeMetrics(pod): Object

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_12","title":"Parameters","text":"Name Type pod Pod"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_16","title":"Returns","text":"

Object

Name Type cpu number memory number"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getpodsbynode","title":"getPodsByNode","text":"

\u25b8 getPodsByNode(node): Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_13","title":"Parameters","text":"Name Type node string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_17","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getpodsbyowner","title":"getPodsByOwner","text":"

\u25b8 getPodsByOwner(workload): Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_14","title":"Parameters","text":"Name Type workload KubeObject<NamespaceScopedMetadata, unknown, unknown>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_18","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getpodsbyownerid","title":"getPodsByOwnerId","text":"

\u25b8 getPodsByOwnerId(workloadId): Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_15","title":"Parameters","text":"Name Type workloadId string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_19","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getstatuses","title":"getStatuses","text":"

\u25b8 getStatuses(pods): Dictionary<number>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_16","title":"Parameters","text":"Name Type pods Pod[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_20","title":"Returns","text":"

Dictionary<number>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_21","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_17","title":"Parameters","text":"Name Type item Pod"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_22","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_18","title":"Parameters","text":"Name Type visibleItems? Pod[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_23","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#load","title":"load","text":"

\u25b8 load(params): Promise<Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_19","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_24","title":"Returns","text":"

Promise<Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Pod[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_20","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_25","title":"Returns","text":"

Promise<undefined | Pod[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_21","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_26","title":"Returns","text":"

Promise<Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_22","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_27","title":"Returns","text":"

Promise<null | Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<Pod[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_23","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_28","title":"Returns","text":"

Promise<Pod[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#loadkubemetrics","title":"loadKubeMetrics","text":"

\u25b8 loadKubeMetrics(namespace?): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_24","title":"Parameters","text":"Name Type namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_25","title":"Parameters","text":"Name Type partialItems Pod[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_30","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_26","title":"Parameters","text":"Name Type item Pod patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_31","title":"Returns","text":"

Promise<Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_27","title":"Parameters","text":"Name Type items Pod[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_32","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | Pod[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_28","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_33","title":"Returns","text":"

Promise<undefined | Pod[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_29","title":"Parameters","text":"Name Type item Pod"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_34","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_30","title":"Parameters","text":"Name Type item Pod request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_35","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_31","title":"Parameters","text":"Name Type items Pod[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_36","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_37","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_32","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_33","title":"Parameters","text":"Name Type item Pod"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_41","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): Pod[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_34","title":"Parameters","text":"Name Type Description items? Pod[] the items to be sorted (default: the current items in this store) sorting? (item: Pod) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_42","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_35","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_43","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_36","title":"Parameters","text":"Name Type item Pod"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_44","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_37","title":"Parameters","text":"Name Type visibleItems? Pod[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_45","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_38","title":"Parameters","text":"Name Type item Pod"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_46","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_39","title":"Parameters","text":"Name Type item Pod data PartialObjectDeep<Pod, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_47","title":"Returns","text":"

Promise<Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_48","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#parameters_40","title":"Parameters","text":"Name Type item Pod request () => Promise<Pod>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_49","title":"Returns","text":"

Promise<Pod>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/","title":"Renderer.K8sApi.PriorityClassStoreStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / PriorityClassStoreStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#class-priorityclassstorestore","title":"Class: PriorityClassStoreStore","text":"

Renderer.K8sApi.PriorityClassStoreStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<PriorityClass, PriorityClassApi>

\u21b3 PriorityClassStoreStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#constructor","title":"constructor","text":"

\u2022 new PriorityClassStoreStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api PriorityClassApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<PriorityClass, PriorityClassApi>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#api","title":"api","text":"

\u2022 Readonly api: PriorityClassApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: PriorityClass) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_1","title":"Parameters","text":"Name Type item PriorityClass"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<PriorityClassData>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#items","title":"items","text":"

\u2022 items: IObservableArray<PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<PriorityClass, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_4","title":"Returns","text":"

Generator<PriorityClass, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<PriorityClass, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_6","title":"Returns","text":"

Promise<PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<PriorityClass, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_7","title":"Returns","text":"

Promise<null | PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): PriorityClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_5","title":"Parameters","text":"Name Type items PriorityClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_8","title":"Returns","text":"

PriorityClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): PriorityClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_9","title":"Returns","text":"

PriorityClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | PriorityClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_10","title":"Returns","text":"

undefined | PriorityClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): PriorityClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_11","title":"Returns","text":"

PriorityClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | PriorityClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_12","title":"Returns","text":"

undefined | PriorityClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | PriorityClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_13","title":"Returns","text":"

undefined | PriorityClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): PriorityClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_15","title":"Returns","text":"

PriorityClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_12","title":"Parameters","text":"Name Type item PriorityClass"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? PriorityClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#load","title":"load","text":"

\u25b8 load(params): Promise<PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_19","title":"Returns","text":"

Promise<PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | PriorityClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_20","title":"Returns","text":"

Promise<undefined | PriorityClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_21","title":"Returns","text":"

Promise<PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_22","title":"Returns","text":"

Promise<null | PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<PriorityClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_23","title":"Returns","text":"

Promise<PriorityClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): PriorityClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_19","title":"Parameters","text":"Name Type partialItems PriorityClass[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_24","title":"Returns","text":"

PriorityClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_20","title":"Parameters","text":"Name Type item PriorityClass patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_25","title":"Returns","text":"

Promise<PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): PriorityClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_21","title":"Parameters","text":"Name Type items PriorityClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_26","title":"Returns","text":"

PriorityClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | PriorityClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_27","title":"Returns","text":"

Promise<undefined | PriorityClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_23","title":"Parameters","text":"Name Type item PriorityClass"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_24","title":"Parameters","text":"Name Type item PriorityClass request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_25","title":"Parameters","text":"Name Type items PriorityClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_27","title":"Parameters","text":"Name Type item PriorityClass"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): PriorityClass[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_28","title":"Parameters","text":"Name Type Description items? PriorityClass[] the items to be sorted (default: the current items in this store) sorting? (item: PriorityClass) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_36","title":"Returns","text":"

PriorityClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_30","title":"Parameters","text":"Name Type item PriorityClass"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? PriorityClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_32","title":"Parameters","text":"Name Type item PriorityClass"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_33","title":"Parameters","text":"Name Type item PriorityClass data PartialObjectDeep<PriorityClass, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_41","title":"Returns","text":"

Promise<PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#parameters_34","title":"Parameters","text":"Name Type item PriorityClass request () => Promise<PriorityClass>"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_43","title":"Returns","text":"

Promise<PriorityClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/","title":"Renderer.K8sApi.ReplicaSetStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / ReplicaSetStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#class-replicasetstore","title":"Class: ReplicaSetStore","text":"

Renderer.K8sApi.ReplicaSetStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<ReplicaSet, ReplicaSetApi>

\u21b3 ReplicaSetStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getChildPods
  • getIndexById
  • getItems
  • getReplicaSetsByOwner
  • getStatuses
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#constructor","title":"constructor","text":"

\u2022 new ReplicaSetStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters","title":"Parameters","text":"Name Type dependencies ReplicaSetStoreDependencies api ReplicaSetApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#overrides","title":"Overrides","text":"

KubeObjectStore<ReplicaSet, ReplicaSetApi\\>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#api","title":"api","text":"

\u2022 Readonly api: ReplicaSetApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: ReplicaSet) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_1","title":"Parameters","text":"Name Type item ReplicaSet"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: ReplicaSetStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#overrides_1","title":"Overrides","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, ReplicaSetStatus, ReplicaSetSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#items","title":"items","text":"

\u2022 items: IObservableArray<ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<ReplicaSet, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_4","title":"Returns","text":"

Generator<ReplicaSet, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<ReplicaSet, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_6","title":"Returns","text":"

Promise<ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<ReplicaSet, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_7","title":"Returns","text":"

Promise<null | ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_5","title":"Parameters","text":"Name Type items ReplicaSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_8","title":"Returns","text":"

ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_9","title":"Returns","text":"

ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | ReplicaSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_10","title":"Returns","text":"

undefined | ReplicaSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_11","title":"Returns","text":"

ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | ReplicaSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_12","title":"Returns","text":"

undefined | ReplicaSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | ReplicaSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_13","title":"Returns","text":"

undefined | ReplicaSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getchildpods","title":"getChildPods","text":"

\u25b8 getChildPods(replicaSet): Pod[]

Deprecated

Switch to using getPodsByOwnerId directly

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_11","title":"Parameters","text":"Name Type replicaSet ReplicaSet"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_14","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_12","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_16","title":"Returns","text":"

ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getreplicasetsbyowner","title":"getReplicaSetsByOwner","text":"

\u25b8 getReplicaSetsByOwner(deployment): ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_13","title":"Parameters","text":"Name Type deployment Deployment"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_17","title":"Returns","text":"

ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getstatuses","title":"getStatuses","text":"

\u25b8 getStatuses(replicaSets): Object

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_14","title":"Parameters","text":"Name Type replicaSets ReplicaSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_18","title":"Returns","text":"

Object

Name Type failed number pending number running number"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_19","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_15","title":"Parameters","text":"Name Type item ReplicaSet"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_20","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_16","title":"Parameters","text":"Name Type visibleItems? ReplicaSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_21","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#load","title":"load","text":"

\u25b8 load(params): Promise<ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_22","title":"Returns","text":"

Promise<ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | ReplicaSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_23","title":"Returns","text":"

Promise<undefined | ReplicaSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_19","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_24","title":"Returns","text":"

Promise<ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_20","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_25","title":"Returns","text":"

Promise<null | ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<ReplicaSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_21","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_26","title":"Returns","text":"

Promise<ReplicaSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_22","title":"Parameters","text":"Name Type partialItems ReplicaSet[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_27","title":"Returns","text":"

ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_23","title":"Parameters","text":"Name Type item ReplicaSet patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_28","title":"Returns","text":"

Promise<ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_24","title":"Parameters","text":"Name Type items ReplicaSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_29","title":"Returns","text":"

ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | ReplicaSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_25","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_30","title":"Returns","text":"

Promise<undefined | ReplicaSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_26","title":"Parameters","text":"Name Type item ReplicaSet"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_27","title":"Parameters","text":"Name Type item ReplicaSet request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_32","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_28","title":"Parameters","text":"Name Type items ReplicaSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_33","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_34","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_29","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_36","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_37","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_30","title":"Parameters","text":"Name Type item ReplicaSet"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): ReplicaSet[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_31","title":"Parameters","text":"Name Type Description items? ReplicaSet[] the items to be sorted (default: the current items in this store) sorting? (item: ReplicaSet) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_39","title":"Returns","text":"

ReplicaSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_32","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_40","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_33","title":"Parameters","text":"Name Type item ReplicaSet"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_41","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_34","title":"Parameters","text":"Name Type visibleItems? ReplicaSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_35","title":"Parameters","text":"Name Type item ReplicaSet"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_43","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_36","title":"Parameters","text":"Name Type item ReplicaSet data PartialObjectDeep<ReplicaSet, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_44","title":"Returns","text":"

Promise<ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_45","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#parameters_37","title":"Parameters","text":"Name Type item ReplicaSet request () => Promise<ReplicaSet>"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_46","title":"Returns","text":"

Promise<ReplicaSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/","title":"Renderer.K8sApi.ResourceQuotasStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / ResourceQuotasStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#class-resourcequotasstore","title":"Class: ResourceQuotasStore","text":"

Renderer.K8sApi.ResourceQuotasStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<ResourceQuota, ResourceQuotaApi>

\u21b3 ResourceQuotasStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#constructor","title":"constructor","text":"

\u2022 new ResourceQuotasStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api ResourceQuotaApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<ResourceQuota, ResourceQuotaApi>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#api","title":"api","text":"

\u2022 Readonly api: ResourceQuotaApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: ResourceQuota) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_1","title":"Parameters","text":"Name Type item ResourceQuota"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, ResourceQuotaStatus, ResourceQuotaSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#items","title":"items","text":"

\u2022 items: IObservableArray<ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<ResourceQuota, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_4","title":"Returns","text":"

Generator<ResourceQuota, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<ResourceQuota, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_6","title":"Returns","text":"

Promise<ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<ResourceQuota, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_7","title":"Returns","text":"

Promise<null | ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): ResourceQuota[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_5","title":"Parameters","text":"Name Type items ResourceQuota[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_8","title":"Returns","text":"

ResourceQuota[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): ResourceQuota[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_9","title":"Returns","text":"

ResourceQuota[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | ResourceQuota

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_10","title":"Returns","text":"

undefined | ResourceQuota

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): ResourceQuota[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_11","title":"Returns","text":"

ResourceQuota[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | ResourceQuota

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_12","title":"Returns","text":"

undefined | ResourceQuota

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | ResourceQuota

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_13","title":"Returns","text":"

undefined | ResourceQuota

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): ResourceQuota[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_15","title":"Returns","text":"

ResourceQuota[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_12","title":"Parameters","text":"Name Type item ResourceQuota"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? ResourceQuota[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#load","title":"load","text":"

\u25b8 load(params): Promise<ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_19","title":"Returns","text":"

Promise<ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | ResourceQuota[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_20","title":"Returns","text":"

Promise<undefined | ResourceQuota[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_21","title":"Returns","text":"

Promise<ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_22","title":"Returns","text":"

Promise<null | ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<ResourceQuota[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_23","title":"Returns","text":"

Promise<ResourceQuota[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): ResourceQuota[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_19","title":"Parameters","text":"Name Type partialItems ResourceQuota[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_24","title":"Returns","text":"

ResourceQuota[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_20","title":"Parameters","text":"Name Type item ResourceQuota patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_25","title":"Returns","text":"

Promise<ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): ResourceQuota[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_21","title":"Parameters","text":"Name Type items ResourceQuota[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_26","title":"Returns","text":"

ResourceQuota[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | ResourceQuota[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_27","title":"Returns","text":"

Promise<undefined | ResourceQuota[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_23","title":"Parameters","text":"Name Type item ResourceQuota"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_24","title":"Parameters","text":"Name Type item ResourceQuota request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_25","title":"Parameters","text":"Name Type items ResourceQuota[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_27","title":"Parameters","text":"Name Type item ResourceQuota"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): ResourceQuota[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_28","title":"Parameters","text":"Name Type Description items? ResourceQuota[] the items to be sorted (default: the current items in this store) sorting? (item: ResourceQuota) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_36","title":"Returns","text":"

ResourceQuota[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_30","title":"Parameters","text":"Name Type item ResourceQuota"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? ResourceQuota[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_32","title":"Parameters","text":"Name Type item ResourceQuota"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_33","title":"Parameters","text":"Name Type item ResourceQuota data PartialObjectDeep<ResourceQuota, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_41","title":"Returns","text":"

Promise<ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#parameters_34","title":"Parameters","text":"Name Type item ResourceQuota request () => Promise<ResourceQuota>"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_43","title":"Returns","text":"

Promise<ResourceQuota>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/","title":"Renderer.K8sApi.RoleBindingsStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / RoleBindingsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#class-rolebindingsstore","title":"Class: RoleBindingsStore","text":"

Renderer.K8sApi.RoleBindingsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<RoleBinding, RoleBindingApi, RoleBindingData>

\u21b3 RoleBindingsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • removeSubjects
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
  • updateSubjects
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#constructor","title":"constructor","text":"

\u2022 new RoleBindingsStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api RoleBindingApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<RoleBinding, RoleBindingApi, RoleBindingData>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#api","title":"api","text":"

\u2022 Readonly api: RoleBindingApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: RoleBinding) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_1","title":"Parameters","text":"Name Type item RoleBinding"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<RoleBindingData>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#items","title":"items","text":"

\u2022 items: IObservableArray<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<RoleBinding, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_4","title":"Returns","text":"

Generator<RoleBinding, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<RoleBinding, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_6","title":"Returns","text":"

Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<RoleBinding, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_7","title":"Returns","text":"

Promise<null | RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): RoleBinding[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_5","title":"Parameters","text":"Name Type items RoleBinding[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_8","title":"Returns","text":"

RoleBinding[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): RoleBinding[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_9","title":"Returns","text":"

RoleBinding[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | RoleBinding

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_10","title":"Returns","text":"

undefined | RoleBinding

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): RoleBinding[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_11","title":"Returns","text":"

RoleBinding[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | RoleBinding

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_12","title":"Returns","text":"

undefined | RoleBinding

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | RoleBinding

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_13","title":"Returns","text":"

undefined | RoleBinding

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): RoleBinding[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_15","title":"Returns","text":"

RoleBinding[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_12","title":"Parameters","text":"Name Type item RoleBinding"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? RoleBinding[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#load","title":"load","text":"

\u25b8 load(params): Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_19","title":"Returns","text":"

Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | RoleBinding[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_20","title":"Returns","text":"

Promise<undefined | RoleBinding[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_21","title":"Returns","text":"

Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_22","title":"Returns","text":"

Promise<null | RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<RoleBinding[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_23","title":"Returns","text":"

Promise<RoleBinding[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): RoleBinding[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_19","title":"Parameters","text":"Name Type partialItems RoleBinding[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_24","title":"Returns","text":"

RoleBinding[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_20","title":"Parameters","text":"Name Type item RoleBinding patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_25","title":"Returns","text":"

Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): RoleBinding[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_21","title":"Parameters","text":"Name Type items RoleBinding[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_26","title":"Returns","text":"

RoleBinding[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | RoleBinding[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_27","title":"Returns","text":"

Promise<undefined | RoleBinding[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_23","title":"Parameters","text":"Name Type item RoleBinding"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_24","title":"Parameters","text":"Name Type item RoleBinding request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_25","title":"Parameters","text":"Name Type items RoleBinding[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#removesubjects","title":"removeSubjects","text":"

\u25b8 removeSubjects(roleBinding, subjectsToRemove): Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_26","title":"Parameters","text":"Name Type roleBinding RoleBinding subjectsToRemove Iterable<Subject>"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_32","title":"Returns","text":"

Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_27","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_28","title":"Parameters","text":"Name Type item RoleBinding"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_36","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items): RoleBinding[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_29","title":"Parameters","text":"Name Type items RoleBinding[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_37","title":"Returns","text":"

RoleBinding[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#overrides","title":"Overrides","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_30","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_38","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_31","title":"Parameters","text":"Name Type item RoleBinding"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_32","title":"Parameters","text":"Name Type visibleItems? RoleBinding[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_33","title":"Parameters","text":"Name Type item RoleBinding"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_41","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_34","title":"Parameters","text":"Name Type item RoleBinding data PartialObjectDeep<RoleBinding, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_42","title":"Returns","text":"

Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_43","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_35","title":"Parameters","text":"Name Type item RoleBinding request () => Promise<RoleBinding>"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_44","title":"Returns","text":"

Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#updatesubjects","title":"updateSubjects","text":"

\u25b8 updateSubjects(roleBinding, subjects): Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#parameters_36","title":"Parameters","text":"Name Type roleBinding RoleBinding subjects Subject[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_45","title":"Returns","text":"

Promise<RoleBinding>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/","title":"Renderer.K8sApi.RolesStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / RolesStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#class-rolesstore","title":"Class: RolesStore","text":"

Renderer.K8sApi.RolesStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<Role, RoleApi, RoleData>

\u21b3 RolesStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#constructor","title":"constructor","text":"

\u2022 new RolesStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api RoleApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<Role, RoleApi, RoleData>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#api","title":"api","text":"

\u2022 Readonly api: RoleApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: Role) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_1","title":"Parameters","text":"Name Type item Role"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<RoleData>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#items","title":"items","text":"

\u2022 items: IObservableArray<Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<Role, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_4","title":"Returns","text":"

Generator<Role, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Role, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_6","title":"Returns","text":"

Promise<Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Role, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_7","title":"Returns","text":"

Promise<null | Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): Role[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_5","title":"Parameters","text":"Name Type items Role[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_8","title":"Returns","text":"

Role[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): Role[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_9","title":"Returns","text":"

Role[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | Role

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_10","title":"Returns","text":"

undefined | Role

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): Role[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_11","title":"Returns","text":"

Role[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | Role

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_12","title":"Returns","text":"

undefined | Role

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | Role

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_13","title":"Returns","text":"

undefined | Role

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): Role[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_15","title":"Returns","text":"

Role[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_12","title":"Parameters","text":"Name Type item Role"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? Role[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#load","title":"load","text":"

\u25b8 load(params): Promise<Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_19","title":"Returns","text":"

Promise<Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Role[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_20","title":"Returns","text":"

Promise<undefined | Role[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_21","title":"Returns","text":"

Promise<Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_22","title":"Returns","text":"

Promise<null | Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<Role[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_23","title":"Returns","text":"

Promise<Role[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Role[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_19","title":"Parameters","text":"Name Type partialItems Role[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_24","title":"Returns","text":"

Role[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_20","title":"Parameters","text":"Name Type item Role patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_25","title":"Returns","text":"

Promise<Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): Role[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_21","title":"Parameters","text":"Name Type items Role[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_26","title":"Returns","text":"

Role[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | Role[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_27","title":"Returns","text":"

Promise<undefined | Role[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_23","title":"Parameters","text":"Name Type item Role"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_24","title":"Parameters","text":"Name Type item Role request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_25","title":"Parameters","text":"Name Type items Role[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_27","title":"Parameters","text":"Name Type item Role"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items): Role[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_28","title":"Parameters","text":"Name Type items Role[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_36","title":"Returns","text":"

Role[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#overrides","title":"Overrides","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_30","title":"Parameters","text":"Name Type item Role"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? Role[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_32","title":"Parameters","text":"Name Type item Role"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_33","title":"Parameters","text":"Name Type item Role data PartialObjectDeep<Role, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_41","title":"Returns","text":"

Promise<Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#parameters_34","title":"Parameters","text":"Name Type item Role request () => Promise<Role>"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_43","title":"Returns","text":"

Promise<Role>

"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/","title":"Renderer.K8sApi.SecretsStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / SecretsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#class-secretsstore","title":"Class: SecretsStore","text":"

Renderer.K8sApi.SecretsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<Secret, SecretApi, SecretData>

\u21b3 SecretsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#constructor","title":"constructor","text":"

\u2022 new SecretsStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api SecretApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<Secret, SecretApi, SecretData>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#api","title":"api","text":"

\u2022 Readonly api: SecretApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: Secret) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_1","title":"Parameters","text":"Name Type item Secret"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<SecretData>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#items","title":"items","text":"

\u2022 items: IObservableArray<Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<Secret, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_4","title":"Returns","text":"

Generator<Secret, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Secret, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_6","title":"Returns","text":"

Promise<Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Secret, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_7","title":"Returns","text":"

Promise<null | Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): Secret[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_5","title":"Parameters","text":"Name Type items Secret[]"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_8","title":"Returns","text":"

Secret[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): Secret[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_9","title":"Returns","text":"

Secret[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | Secret

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_10","title":"Returns","text":"

undefined | Secret

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): Secret[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_11","title":"Returns","text":"

Secret[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | Secret

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_12","title":"Returns","text":"

undefined | Secret

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | Secret

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_13","title":"Returns","text":"

undefined | Secret

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): Secret[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_15","title":"Returns","text":"

Secret[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_12","title":"Parameters","text":"Name Type item Secret"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? Secret[]"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#load","title":"load","text":"

\u25b8 load(params): Promise<Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_19","title":"Returns","text":"

Promise<Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Secret[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_20","title":"Returns","text":"

Promise<undefined | Secret[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_21","title":"Returns","text":"

Promise<Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_22","title":"Returns","text":"

Promise<null | Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<Secret[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_23","title":"Returns","text":"

Promise<Secret[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Secret[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_19","title":"Parameters","text":"Name Type partialItems Secret[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_24","title":"Returns","text":"

Secret[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_20","title":"Parameters","text":"Name Type item Secret patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_25","title":"Returns","text":"

Promise<Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): Secret[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_21","title":"Parameters","text":"Name Type items Secret[]"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_26","title":"Returns","text":"

Secret[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | Secret[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_27","title":"Returns","text":"

Promise<undefined | Secret[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_23","title":"Parameters","text":"Name Type item Secret"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_24","title":"Parameters","text":"Name Type item Secret request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_25","title":"Parameters","text":"Name Type items Secret[]"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_27","title":"Parameters","text":"Name Type item Secret"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): Secret[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_28","title":"Parameters","text":"Name Type Description items? Secret[] the items to be sorted (default: the current items in this store) sorting? (item: Secret) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_36","title":"Returns","text":"

Secret[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_30","title":"Parameters","text":"Name Type item Secret"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? Secret[]"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_32","title":"Parameters","text":"Name Type item Secret"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_33","title":"Parameters","text":"Name Type item Secret data PartialObjectDeep<Secret, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_41","title":"Returns","text":"

Promise<Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#parameters_34","title":"Parameters","text":"Name Type item Secret request () => Promise<Secret>"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_43","title":"Returns","text":"

Promise<Secret>

"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/","title":"Renderer.K8sApi.ServiceAccountsStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / ServiceAccountsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#class-serviceaccountsstore","title":"Class: ServiceAccountsStore","text":"

Renderer.K8sApi.ServiceAccountsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<ServiceAccount, ServiceAccountApi, ServiceAccountData>

\u21b3 ServiceAccountsStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#constructor","title":"constructor","text":"

\u2022 new ServiceAccountsStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api ServiceAccountApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<ServiceAccount, ServiceAccountApi, ServiceAccountData>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#api","title":"api","text":"

\u2022 Readonly api: ServiceAccountApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: ServiceAccount) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_1","title":"Parameters","text":"Name Type item ServiceAccount"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<ServiceAccountData>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#items","title":"items","text":"

\u2022 items: IObservableArray<ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<ServiceAccount, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_4","title":"Returns","text":"

Generator<ServiceAccount, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<ServiceAccount, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_6","title":"Returns","text":"

Promise<ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params): Promise<null | ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_7","title":"Returns","text":"

Promise<null | ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#overrides","title":"Overrides","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): ServiceAccount[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_5","title":"Parameters","text":"Name Type items ServiceAccount[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_8","title":"Returns","text":"

ServiceAccount[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): ServiceAccount[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_9","title":"Returns","text":"

ServiceAccount[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | ServiceAccount

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_10","title":"Returns","text":"

undefined | ServiceAccount

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): ServiceAccount[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_11","title":"Returns","text":"

ServiceAccount[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | ServiceAccount

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_12","title":"Returns","text":"

undefined | ServiceAccount

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | ServiceAccount

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_13","title":"Returns","text":"

undefined | ServiceAccount

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): ServiceAccount[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_15","title":"Returns","text":"

ServiceAccount[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_12","title":"Parameters","text":"Name Type item ServiceAccount"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? ServiceAccount[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#load","title":"load","text":"

\u25b8 load(params): Promise<ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_19","title":"Returns","text":"

Promise<ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | ServiceAccount[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_20","title":"Returns","text":"

Promise<undefined | ServiceAccount[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_21","title":"Returns","text":"

Promise<ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_22","title":"Returns","text":"

Promise<null | ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<ServiceAccount[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_23","title":"Returns","text":"

Promise<ServiceAccount[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): ServiceAccount[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_19","title":"Parameters","text":"Name Type partialItems ServiceAccount[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_24","title":"Returns","text":"

ServiceAccount[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_20","title":"Parameters","text":"Name Type item ServiceAccount patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_25","title":"Returns","text":"

Promise<ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): ServiceAccount[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_21","title":"Parameters","text":"Name Type items ServiceAccount[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_26","title":"Returns","text":"

ServiceAccount[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | ServiceAccount[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_27","title":"Returns","text":"

Promise<undefined | ServiceAccount[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_23","title":"Parameters","text":"Name Type item ServiceAccount"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_24","title":"Parameters","text":"Name Type item ServiceAccount request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_25","title":"Parameters","text":"Name Type items ServiceAccount[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_27","title":"Parameters","text":"Name Type item ServiceAccount"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): ServiceAccount[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_28","title":"Parameters","text":"Name Type Description items? ServiceAccount[] the items to be sorted (default: the current items in this store) sorting? (item: ServiceAccount) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_36","title":"Returns","text":"

ServiceAccount[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_30","title":"Parameters","text":"Name Type item ServiceAccount"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? ServiceAccount[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_32","title":"Parameters","text":"Name Type item ServiceAccount"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_33","title":"Parameters","text":"Name Type item ServiceAccount data PartialObjectDeep<ServiceAccount, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_41","title":"Returns","text":"

Promise<ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#parameters_34","title":"Parameters","text":"Name Type item ServiceAccount request () => Promise<ServiceAccount>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_43","title":"Returns","text":"

Promise<ServiceAccount>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/","title":"Renderer.K8sApi.ServiceStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / ServiceStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#class-servicestore","title":"Class: ServiceStore","text":"

Renderer.K8sApi.ServiceStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<Service, ServiceApi>

\u21b3 ServiceStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#constructor","title":"constructor","text":"

\u2022 new ServiceStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api ServiceApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<Service, ServiceApi>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#api","title":"api","text":"

\u2022 Readonly api: ServiceApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: Service) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_1","title":"Parameters","text":"Name Type item Service"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, ServiceStatus, ServiceSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#items","title":"items","text":"

\u2022 items: IObservableArray<Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<Service, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_4","title":"Returns","text":"

Generator<Service, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Service, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_6","title":"Returns","text":"

Promise<Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<Service, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_7","title":"Returns","text":"

Promise<null | Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): Service[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_5","title":"Parameters","text":"Name Type items Service[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_8","title":"Returns","text":"

Service[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): Service[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_9","title":"Returns","text":"

Service[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | Service

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_10","title":"Returns","text":"

undefined | Service

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): Service[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_11","title":"Returns","text":"

Service[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | Service

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_12","title":"Returns","text":"

undefined | Service

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | Service

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_13","title":"Returns","text":"

undefined | Service

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): Service[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_15","title":"Returns","text":"

Service[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_12","title":"Parameters","text":"Name Type item Service"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? Service[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#load","title":"load","text":"

\u25b8 load(params): Promise<Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_19","title":"Returns","text":"

Promise<Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Service[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_20","title":"Returns","text":"

Promise<undefined | Service[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_21","title":"Returns","text":"

Promise<Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_22","title":"Returns","text":"

Promise<null | Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<Service[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_23","title":"Returns","text":"

Promise<Service[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Service[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_19","title":"Parameters","text":"Name Type partialItems Service[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_24","title":"Returns","text":"

Service[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_20","title":"Parameters","text":"Name Type item Service patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_25","title":"Returns","text":"

Promise<Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): Service[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_21","title":"Parameters","text":"Name Type items Service[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_26","title":"Returns","text":"

Service[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | Service[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_27","title":"Returns","text":"

Promise<undefined | Service[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_23","title":"Parameters","text":"Name Type item Service"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_24","title":"Parameters","text":"Name Type item Service request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_25","title":"Parameters","text":"Name Type items Service[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_27","title":"Parameters","text":"Name Type item Service"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): Service[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_28","title":"Parameters","text":"Name Type Description items? Service[] the items to be sorted (default: the current items in this store) sorting? (item: Service) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_36","title":"Returns","text":"

Service[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_30","title":"Parameters","text":"Name Type item Service"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? Service[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_32","title":"Parameters","text":"Name Type item Service"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_33","title":"Parameters","text":"Name Type item Service data PartialObjectDeep<Service, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_41","title":"Returns","text":"

Promise<Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#parameters_34","title":"Parameters","text":"Name Type item Service request () => Promise<Service>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_43","title":"Returns","text":"

Promise<Service>

"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/","title":"Renderer.K8sApi.StatefulSetStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / StatefulSetStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#class-statefulsetstore","title":"Class: StatefulSetStore","text":"

Renderer.K8sApi.StatefulSetStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<StatefulSet, StatefulSetApi>

\u21b3 StatefulSetStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getChildPods
  • getIndexById
  • getItems
  • getStatuses
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#constructor","title":"constructor","text":"

\u2022 new StatefulSetStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters","title":"Parameters","text":"Name Type dependencies Dependencies api StatefulSetApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#overrides","title":"Overrides","text":"

KubeObjectStore<StatefulSet, StatefulSetApi\\>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#api","title":"api","text":"

\u2022 Readonly api: StatefulSetApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: StatefulSet) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_1","title":"Parameters","text":"Name Type item StatefulSet"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: Dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#overrides_1","title":"Overrides","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, StatefulSetStatus, StatefulSetSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#items","title":"items","text":"

\u2022 items: IObservableArray<StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<StatefulSet, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_4","title":"Returns","text":"

Generator<StatefulSet, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<StatefulSet, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_6","title":"Returns","text":"

Promise<StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<StatefulSet, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_7","title":"Returns","text":"

Promise<null | StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): StatefulSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_5","title":"Parameters","text":"Name Type items StatefulSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_8","title":"Returns","text":"

StatefulSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): StatefulSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_9","title":"Returns","text":"

StatefulSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | StatefulSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_10","title":"Returns","text":"

undefined | StatefulSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): StatefulSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_11","title":"Returns","text":"

StatefulSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | StatefulSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_12","title":"Returns","text":"

undefined | StatefulSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | StatefulSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_13","title":"Returns","text":"

undefined | StatefulSet

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getchildpods","title":"getChildPods","text":"

\u25b8 getChildPods(statefulSet): Pod[]

Deprecated

Switch to using getPodsByOwnerId directly

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_11","title":"Parameters","text":"Name Type statefulSet StatefulSet"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_14","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_12","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_15","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): StatefulSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_16","title":"Returns","text":"

StatefulSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getstatuses","title":"getStatuses","text":"

\u25b8 getStatuses(statefulSets): Object

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_13","title":"Parameters","text":"Name Type statefulSets StatefulSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_17","title":"Returns","text":"

Object

Name Type failed number pending number running number"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_18","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_14","title":"Parameters","text":"Name Type item StatefulSet"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_19","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_15","title":"Parameters","text":"Name Type visibleItems? StatefulSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_20","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#load","title":"load","text":"

\u25b8 load(params): Promise<StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_16","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_21","title":"Returns","text":"

Promise<StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | StatefulSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_17","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_22","title":"Returns","text":"

Promise<undefined | StatefulSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_18","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_23","title":"Returns","text":"

Promise<StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_19","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_24","title":"Returns","text":"

Promise<null | StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<StatefulSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_20","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_25","title":"Returns","text":"

Promise<StatefulSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): StatefulSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_21","title":"Parameters","text":"Name Type partialItems StatefulSet[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_26","title":"Returns","text":"

StatefulSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_22","title":"Parameters","text":"Name Type item StatefulSet patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_27","title":"Returns","text":"

Promise<StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): StatefulSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_23","title":"Parameters","text":"Name Type items StatefulSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_28","title":"Returns","text":"

StatefulSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | StatefulSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_24","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_29","title":"Returns","text":"

Promise<undefined | StatefulSet[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_25","title":"Parameters","text":"Name Type item StatefulSet"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_26","title":"Parameters","text":"Name Type item StatefulSet request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_27","title":"Parameters","text":"Name Type items StatefulSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_32","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_33","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_28","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_36","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_29","title":"Parameters","text":"Name Type item StatefulSet"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_37","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): StatefulSet[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_30","title":"Parameters","text":"Name Type Description items? StatefulSet[] the items to be sorted (default: the current items in this store) sorting? (item: StatefulSet) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_38","title":"Returns","text":"

StatefulSet[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_31","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_39","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_32","title":"Parameters","text":"Name Type item StatefulSet"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_33","title":"Parameters","text":"Name Type visibleItems? StatefulSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_41","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_34","title":"Parameters","text":"Name Type item StatefulSet"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_35","title":"Parameters","text":"Name Type item StatefulSet data PartialObjectDeep<StatefulSet, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_43","title":"Returns","text":"

Promise<StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_44","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#parameters_36","title":"Parameters","text":"Name Type item StatefulSet request () => Promise<StatefulSet>"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_45","title":"Returns","text":"

Promise<StatefulSet>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/","title":"Renderer.K8sApi.StorageClassStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / StorageClassStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#class-storageclassstore","title":"Class: StorageClassStore","text":"

Renderer.K8sApi.StorageClassStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<StorageClass, StorageClassApi, StorageClassData>

\u21b3 StorageClassStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getPersistentVolumes
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#constructor","title":"constructor","text":"

\u2022 new StorageClassStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters","title":"Parameters","text":"Name Type dependencies StorageClassStoreDependencies api StorageClassApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#overrides","title":"Overrides","text":"

KubeObjectStore<StorageClass, StorageClassApi, StorageClassData\\>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#api","title":"api","text":"

\u2022 Readonly api: StorageClassApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: StorageClass) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_1","title":"Parameters","text":"Name Type item StorageClass"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: StorageClassStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#overrides_1","title":"Overrides","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<StorageClassData>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#items","title":"items","text":"

\u2022 items: IObservableArray<StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<StorageClass, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_4","title":"Returns","text":"

Generator<StorageClass, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<StorageClass, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_6","title":"Returns","text":"

Promise<StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<StorageClass, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_7","title":"Returns","text":"

Promise<null | StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): StorageClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_5","title":"Parameters","text":"Name Type items StorageClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_8","title":"Returns","text":"

StorageClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): StorageClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_9","title":"Returns","text":"

StorageClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | StorageClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_10","title":"Returns","text":"

undefined | StorageClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): StorageClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_11","title":"Returns","text":"

StorageClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | StorageClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_12","title":"Returns","text":"

undefined | StorageClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | StorageClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_13","title":"Returns","text":"

undefined | StorageClass

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): StorageClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_15","title":"Returns","text":"

StorageClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getpersistentvolumes","title":"getPersistentVolumes","text":"

\u25b8 getPersistentVolumes(storageClass): PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_12","title":"Parameters","text":"Name Type storageClass StorageClass"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_16","title":"Returns","text":"

PersistentVolume[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_17","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_13","title":"Parameters","text":"Name Type item StorageClass"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_14","title":"Parameters","text":"Name Type visibleItems? StorageClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_19","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#load","title":"load","text":"

\u25b8 load(params): Promise<StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_15","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_20","title":"Returns","text":"

Promise<StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | StorageClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_16","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_21","title":"Returns","text":"

Promise<undefined | StorageClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_17","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_22","title":"Returns","text":"

Promise<StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_18","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_23","title":"Returns","text":"

Promise<null | StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<StorageClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_19","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_24","title":"Returns","text":"

Promise<StorageClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): StorageClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_20","title":"Parameters","text":"Name Type partialItems StorageClass[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_25","title":"Returns","text":"

StorageClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_21","title":"Parameters","text":"Name Type item StorageClass patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_26","title":"Returns","text":"

Promise<StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): StorageClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_22","title":"Parameters","text":"Name Type items StorageClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_27","title":"Returns","text":"

StorageClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | StorageClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_23","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_28","title":"Returns","text":"

Promise<undefined | StorageClass[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_24","title":"Parameters","text":"Name Type item StorageClass"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_25","title":"Parameters","text":"Name Type item StorageClass request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_26","title":"Parameters","text":"Name Type items StorageClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_32","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_27","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_28","title":"Parameters","text":"Name Type item StorageClass"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_36","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): StorageClass[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_29","title":"Parameters","text":"Name Type Description items? StorageClass[] the items to be sorted (default: the current items in this store) sorting? (item: StorageClass) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_37","title":"Returns","text":"

StorageClass[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_30","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_38","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_31","title":"Parameters","text":"Name Type item StorageClass"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_32","title":"Parameters","text":"Name Type visibleItems? StorageClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_33","title":"Parameters","text":"Name Type item StorageClass"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_41","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_34","title":"Parameters","text":"Name Type item StorageClass data PartialObjectDeep<StorageClass, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_42","title":"Returns","text":"

Promise<StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_43","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#parameters_35","title":"Parameters","text":"Name Type item StorageClass request () => Promise<StorageClass>"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_44","title":"Returns","text":"

Promise<StorageClass>

"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/","title":"Renderer.K8sApi.VerticalPodAutoscalerStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / VerticalPodAutoscalerStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#class-verticalpodautoscalerstore","title":"Class: VerticalPodAutoscalerStore","text":"

Renderer.K8sApi.VerticalPodAutoscalerStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<VerticalPodAutoscaler, VerticalPodAutoscalerApi>

\u21b3 VerticalPodAutoscalerStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#constructor","title":"constructor","text":"

\u2022 new VerticalPodAutoscalerStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api VerticalPodAutoscalerApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<VerticalPodAutoscaler, VerticalPodAutoscalerApi>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#api","title":"api","text":"

\u2022 Readonly api: VerticalPodAutoscalerApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: VerticalPodAutoscaler) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_1","title":"Parameters","text":"Name Type item VerticalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, VerticalPodAutoscalerStatus, VerticalPodAutoscalerSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#items","title":"items","text":"

\u2022 items: IObservableArray<VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<VerticalPodAutoscaler, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_4","title":"Returns","text":"

Generator<VerticalPodAutoscaler, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<VerticalPodAutoscaler, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_6","title":"Returns","text":"

Promise<VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<VerticalPodAutoscaler, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_7","title":"Returns","text":"

Promise<null | VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): VerticalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_5","title":"Parameters","text":"Name Type items VerticalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_8","title":"Returns","text":"

VerticalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): VerticalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_9","title":"Returns","text":"

VerticalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | VerticalPodAutoscaler

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_10","title":"Returns","text":"

undefined | VerticalPodAutoscaler

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): VerticalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_11","title":"Returns","text":"

VerticalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | VerticalPodAutoscaler

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_12","title":"Returns","text":"

undefined | VerticalPodAutoscaler

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | VerticalPodAutoscaler

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_13","title":"Returns","text":"

undefined | VerticalPodAutoscaler

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): VerticalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_15","title":"Returns","text":"

VerticalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_12","title":"Parameters","text":"Name Type item VerticalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? VerticalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#load","title":"load","text":"

\u25b8 load(params): Promise<VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_19","title":"Returns","text":"

Promise<VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | VerticalPodAutoscaler[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_20","title":"Returns","text":"

Promise<undefined | VerticalPodAutoscaler[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_21","title":"Returns","text":"

Promise<VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_22","title":"Returns","text":"

Promise<null | VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<VerticalPodAutoscaler[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_23","title":"Returns","text":"

Promise<VerticalPodAutoscaler[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): VerticalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_19","title":"Parameters","text":"Name Type partialItems VerticalPodAutoscaler[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_24","title":"Returns","text":"

VerticalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_20","title":"Parameters","text":"Name Type item VerticalPodAutoscaler patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_25","title":"Returns","text":"

Promise<VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): VerticalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_21","title":"Parameters","text":"Name Type items VerticalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_26","title":"Returns","text":"

VerticalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | VerticalPodAutoscaler[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_27","title":"Returns","text":"

Promise<undefined | VerticalPodAutoscaler[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_23","title":"Parameters","text":"Name Type item VerticalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_24","title":"Parameters","text":"Name Type item VerticalPodAutoscaler request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_25","title":"Parameters","text":"Name Type items VerticalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_27","title":"Parameters","text":"Name Type item VerticalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): VerticalPodAutoscaler[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_28","title":"Parameters","text":"Name Type Description items? VerticalPodAutoscaler[] the items to be sorted (default: the current items in this store) sorting? (item: VerticalPodAutoscaler) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_36","title":"Returns","text":"

VerticalPodAutoscaler[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_30","title":"Parameters","text":"Name Type item VerticalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? VerticalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_32","title":"Parameters","text":"Name Type item VerticalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_33","title":"Parameters","text":"Name Type item VerticalPodAutoscaler data PartialObjectDeep<VerticalPodAutoscaler, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_41","title":"Returns","text":"

Promise<VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#parameters_34","title":"Parameters","text":"Name Type item VerticalPodAutoscaler request () => Promise<VerticalPodAutoscaler>"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_43","title":"Returns","text":"

Promise<VerticalPodAutoscaler>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/","title":"Renderer.K8sApi.VolumeClaimStore","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / VolumeClaimStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#class-volumeclaimstore","title":"Class: VolumeClaimStore","text":"

Renderer.K8sApi.VolumeClaimStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#hierarchy","title":"Hierarchy","text":"
  • KubeObjectStore<PersistentVolumeClaim, PersistentVolumeClaimApi>

\u21b3 VolumeClaimStore

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#properties","title":"Properties","text":"
  • api
  • bufferSize
  • defaultSorting
  • dependencies
  • eventsBuffer
  • failedLoading
  • isLoaded
  • isLoading
  • items
  • limit
  • selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#accessors","title":"Accessors","text":"
  • contextItems
  • query
  • selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#methods","title":"Methods","text":"
  • [iterator]
  • bindWatchEventsUpdater
  • create
  • createItem
  • filterItemsOnLoad
  • getAllByNs
  • getById
  • getByLabel
  • getByName
  • getByPath
  • getIndexById
  • getItems
  • getTotalCount
  • isSelected
  • isSelectedAll
  • load
  • loadAll
  • loadFromPath
  • loadItem
  • loadItems
  • mergeItems
  • patch
  • pickOnlySelected
  • reloadAll
  • remove
  • removeItem
  • removeItems
  • removeSelectedItems
  • reset
  • resetOnError
  • resetSelection
  • select
  • sortItems
  • subscribe
  • toggleSelection
  • toggleSelectionAll
  • unselect
  • update
  • updateFromEventsBuffer
  • updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#constructor","title":"constructor","text":"

\u2022 new VolumeClaimStore(dependencies, api, opts?)

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters","title":"Parameters","text":"Name Type dependencies KubeObjectStoreDependencies api PersistentVolumeClaimApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from","title":"Inherited from","text":"

KubeObjectStore<PersistentVolumeClaim, PersistentVolumeClaimApi>.constructor

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#api","title":"api","text":"

\u2022 Readonly api: PersistentVolumeClaimApi

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_1","title":"Inherited from","text":"

KubeObjectStore.api

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#buffersize","title":"bufferSize","text":"

\u2022 Readonly bufferSize: number

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_2","title":"Inherited from","text":"

KubeObjectStore.bufferSize

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#defaultsorting","title":"defaultSorting","text":"

\u2022 Protected defaultSorting: (item: PersistentVolumeClaim) => string

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#type-declaration","title":"Type declaration","text":"

\u25b8 (item): string

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_1","title":"Parameters","text":"Name Type item PersistentVolumeClaim"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_3","title":"Inherited from","text":"

KubeObjectStore.defaultSorting

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_4","title":"Inherited from","text":"

KubeObjectStore.dependencies

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#eventsbuffer","title":"eventsBuffer","text":"

\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, PersistentVolumeClaimStatus, PersistentVolumeClaimSpec>>>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_5","title":"Inherited from","text":"

KubeObjectStore.eventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#failedloading","title":"failedLoading","text":"

\u2022 failedLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_6","title":"Inherited from","text":"

KubeObjectStore.failedLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#isloaded","title":"isLoaded","text":"

\u2022 isLoaded: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_7","title":"Inherited from","text":"

KubeObjectStore.isLoaded

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#isloading","title":"isLoading","text":"

\u2022 isLoading: boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_8","title":"Inherited from","text":"

KubeObjectStore.isLoading

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#items","title":"items","text":"

\u2022 items: IObservableArray<PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_9","title":"Inherited from","text":"

KubeObjectStore.items

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#limit","title":"limit","text":"

\u2022 Readonly limit: undefined | number

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_10","title":"Inherited from","text":"

KubeObjectStore.limit

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#selecteditemsids","title":"selectedItemsIds","text":"

\u2022 selectedItemsIds: ObservableSet<string>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_11","title":"Inherited from","text":"

KubeObjectStore.selectedItemsIds

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#contextitems","title":"contextItems","text":"

\u2022 get contextItems(): K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_1","title":"Returns","text":"

K[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_12","title":"Inherited from","text":"

KubeObjectStore.contextItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#query","title":"query","text":"

\u2022 get query(): KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_2","title":"Returns","text":"

KubeApiQueryParams

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_13","title":"Inherited from","text":"

KubeObjectStore.query

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#selecteditems","title":"selectedItems","text":"

\u2022 get selectedItems(): Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_3","title":"Returns","text":"

Item[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_14","title":"Inherited from","text":"

KubeObjectStore.selectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#iterator","title":"[iterator]","text":"

\u25b8 [iterator](): Generator<PersistentVolumeClaim, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_4","title":"Returns","text":"

Generator<PersistentVolumeClaim, void, undefined>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_15","title":"Inherited from","text":"

KubeObjectStore.[iterator]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"

\u25b8 Protected bindWatchEventsUpdater(delay?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_2","title":"Parameters","text":"Name Type delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_16","title":"Inherited from","text":"

KubeObjectStore.bindWatchEventsUpdater

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#create","title":"create","text":"

\u25b8 create(params, data?): Promise<PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_3","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<PersistentVolumeClaim, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_6","title":"Returns","text":"

Promise<PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_17","title":"Inherited from","text":"

KubeObjectStore.create

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#createitem","title":"createItem","text":"

\u25b8 Protected createItem(params, data?): Promise<null | PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_4","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string data? PartialObjectDeep<PersistentVolumeClaim, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_7","title":"Returns","text":"

Promise<null | PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_18","title":"Inherited from","text":"

KubeObjectStore.createItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#filteritemsonload","title":"filterItemsOnLoad","text":"

\u25b8 Protected filterItemsOnLoad(items): PersistentVolumeClaim[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_5","title":"Parameters","text":"Name Type items PersistentVolumeClaim[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_8","title":"Returns","text":"

PersistentVolumeClaim[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_19","title":"Inherited from","text":"

KubeObjectStore.filterItemsOnLoad

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getallbyns","title":"getAllByNs","text":"

\u25b8 getAllByNs(namespace, strict?): PersistentVolumeClaim[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_6","title":"Parameters","text":"Name Type namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_9","title":"Returns","text":"

PersistentVolumeClaim[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_20","title":"Inherited from","text":"

KubeObjectStore.getAllByNs

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getbyid","title":"getById","text":"

\u25b8 getById(id): undefined | PersistentVolumeClaim

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_7","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_10","title":"Returns","text":"

undefined | PersistentVolumeClaim

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_21","title":"Inherited from","text":"

KubeObjectStore.getById

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getbylabel","title":"getByLabel","text":"

\u25b8 getByLabel(labels): PersistentVolumeClaim[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_8","title":"Parameters","text":"Name Type labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_11","title":"Returns","text":"

PersistentVolumeClaim[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_22","title":"Inherited from","text":"

KubeObjectStore.getByLabel

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getbyname","title":"getByName","text":"

\u25b8 getByName(name, namespace?): undefined | PersistentVolumeClaim

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_9","title":"Parameters","text":"Name Type name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_12","title":"Returns","text":"

undefined | PersistentVolumeClaim

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_23","title":"Inherited from","text":"

KubeObjectStore.getByName

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getbypath","title":"getByPath","text":"

\u25b8 getByPath(path): undefined | PersistentVolumeClaim

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_10","title":"Parameters","text":"Name Type path string"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_13","title":"Returns","text":"

undefined | PersistentVolumeClaim

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_24","title":"Inherited from","text":"

KubeObjectStore.getByPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getindexbyid","title":"getIndexById","text":"

\u25b8 getIndexById(id): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_11","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_14","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_25","title":"Inherited from","text":"

KubeObjectStore.getIndexById

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getitems","title":"getItems","text":"

\u25b8 getItems(): PersistentVolumeClaim[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_15","title":"Returns","text":"

PersistentVolumeClaim[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_26","title":"Inherited from","text":"

KubeObjectStore.getItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#gettotalcount","title":"getTotalCount","text":"

\u25b8 getTotalCount(): number

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_16","title":"Returns","text":"

number

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_27","title":"Inherited from","text":"

KubeObjectStore.getTotalCount

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#isselected","title":"isSelected","text":"

\u25b8 isSelected(item): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_12","title":"Parameters","text":"Name Type item PersistentVolumeClaim"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_17","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_28","title":"Inherited from","text":"

KubeObjectStore.isSelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#isselectedall","title":"isSelectedAll","text":"

\u25b8 isSelectedAll(visibleItems?): boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_13","title":"Parameters","text":"Name Type visibleItems? PersistentVolumeClaim[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_18","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_29","title":"Inherited from","text":"

KubeObjectStore.isSelectedAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#load","title":"load","text":"

\u25b8 load(params): Promise<PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_14","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_19","title":"Returns","text":"

Promise<PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_30","title":"Inherited from","text":"

KubeObjectStore.load

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#loadall","title":"loadAll","text":"

\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | PersistentVolumeClaim[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_15","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_20","title":"Returns","text":"

Promise<undefined | PersistentVolumeClaim[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_31","title":"Inherited from","text":"

KubeObjectStore.loadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#loadfrompath","title":"loadFromPath","text":"

\u25b8 loadFromPath(resourcePath): Promise<PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_16","title":"Parameters","text":"Name Type resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_21","title":"Returns","text":"

Promise<PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_32","title":"Inherited from","text":"

KubeObjectStore.loadFromPath

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#loaditem","title":"loadItem","text":"

\u25b8 Protected loadItem(params): Promise<null | PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_17","title":"Parameters","text":"Name Type params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_22","title":"Returns","text":"

Promise<null | PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_33","title":"Inherited from","text":"

KubeObjectStore.loadItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#loaditems","title":"loadItems","text":"

\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<PersistentVolumeClaim[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_18","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_23","title":"Returns","text":"

Promise<PersistentVolumeClaim[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_34","title":"Inherited from","text":"

KubeObjectStore.loadItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#mergeitems","title":"mergeItems","text":"

\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): PersistentVolumeClaim[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_19","title":"Parameters","text":"Name Type partialItems PersistentVolumeClaim[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_24","title":"Returns","text":"

PersistentVolumeClaim[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_35","title":"Inherited from","text":"

KubeObjectStore.mergeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#patch","title":"patch","text":"

\u25b8 patch(item, patch): Promise<PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_20","title":"Parameters","text":"Name Type item PersistentVolumeClaim patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_25","title":"Returns","text":"

Promise<PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_36","title":"Inherited from","text":"

KubeObjectStore.patch

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#pickonlyselected","title":"pickOnlySelected","text":"

\u25b8 pickOnlySelected(items): PersistentVolumeClaim[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_21","title":"Parameters","text":"Name Type items PersistentVolumeClaim[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_26","title":"Returns","text":"

PersistentVolumeClaim[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_37","title":"Inherited from","text":"

KubeObjectStore.pickOnlySelected

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#reloadall","title":"reloadAll","text":"

\u25b8 reloadAll(opts?): Promise<undefined | PersistentVolumeClaim[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_22","title":"Parameters","text":"Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_27","title":"Returns","text":"

Promise<undefined | PersistentVolumeClaim[]>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_38","title":"Inherited from","text":"

KubeObjectStore.reloadAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#remove","title":"remove","text":"

\u25b8 remove(item): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_23","title":"Parameters","text":"Name Type item PersistentVolumeClaim"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_28","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_39","title":"Inherited from","text":"

KubeObjectStore.remove

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#removeitem","title":"removeItem","text":"

\u25b8 Protected removeItem(item, request): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_24","title":"Parameters","text":"Name Type item PersistentVolumeClaim request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_29","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_40","title":"Inherited from","text":"

KubeObjectStore.removeItem

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#removeitems","title":"removeItems","text":"

\u25b8 removeItems(items): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_25","title":"Parameters","text":"Name Type items PersistentVolumeClaim[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_30","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_41","title":"Inherited from","text":"

KubeObjectStore.removeItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#removeselecteditems","title":"removeSelectedItems","text":"

\u25b8 removeSelectedItems(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_31","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_42","title":"Inherited from","text":"

KubeObjectStore.removeSelectedItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#reset","title":"reset","text":"

\u25b8 reset(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_32","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_43","title":"Inherited from","text":"

KubeObjectStore.reset

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#resetonerror","title":"resetOnError","text":"

\u25b8 Protected resetOnError(error): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_26","title":"Parameters","text":"Name Type error any"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_33","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_44","title":"Inherited from","text":"

KubeObjectStore.resetOnError

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#resetselection","title":"resetSelection","text":"

\u25b8 resetSelection(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_34","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_45","title":"Inherited from","text":"

KubeObjectStore.resetSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#select","title":"select","text":"

\u25b8 select(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_27","title":"Parameters","text":"Name Type item PersistentVolumeClaim"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_35","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_46","title":"Inherited from","text":"

KubeObjectStore.select

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#sortitems","title":"sortItems","text":"

\u25b8 Protected sortItems(items?, sorting?, order?): PersistentVolumeClaim[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_28","title":"Parameters","text":"Name Type Description items? PersistentVolumeClaim[] the items to be sorted (default: the current items in this store) sorting? (item: PersistentVolumeClaim) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_36","title":"Returns","text":"

PersistentVolumeClaim[]

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_47","title":"Inherited from","text":"

KubeObjectStore.sortItems

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#subscribe","title":"subscribe","text":"

\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_29","title":"Parameters","text":"Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_37","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_48","title":"Inherited from","text":"

KubeObjectStore.subscribe

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#toggleselection","title":"toggleSelection","text":"

\u25b8 toggleSelection(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_30","title":"Parameters","text":"Name Type item PersistentVolumeClaim"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_38","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_49","title":"Inherited from","text":"

KubeObjectStore.toggleSelection

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#toggleselectionall","title":"toggleSelectionAll","text":"

\u25b8 toggleSelectionAll(visibleItems?): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_31","title":"Parameters","text":"Name Type visibleItems? PersistentVolumeClaim[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_39","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_50","title":"Inherited from","text":"

KubeObjectStore.toggleSelectionAll

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#unselect","title":"unselect","text":"

\u25b8 unselect(item): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_32","title":"Parameters","text":"Name Type item PersistentVolumeClaim"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_40","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_51","title":"Inherited from","text":"

KubeObjectStore.unselect

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#update","title":"update","text":"

\u25b8 update(item, data): Promise<PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_33","title":"Parameters","text":"Name Type item PersistentVolumeClaim data PartialObjectDeep<PersistentVolumeClaim, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_41","title":"Returns","text":"

Promise<PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_52","title":"Inherited from","text":"

KubeObjectStore.update

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"

\u25b8 Protected updateFromEventsBuffer(): void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_42","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_53","title":"Inherited from","text":"

KubeObjectStore.updateFromEventsBuffer

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#updateitem","title":"updateItem","text":"

\u25b8 Protected updateItem(item, request): Promise<PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#parameters_34","title":"Parameters","text":"Name Type item PersistentVolumeClaim request () => Promise<PersistentVolumeClaim>"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_43","title":"Returns","text":"

Promise<PersistentVolumeClaim>

"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from_54","title":"Inherited from","text":"

KubeObjectStore.updateItem

"},{"location":"extensions/api/classes/Renderer.LensExtension/","title":"Renderer.LensExtension","text":"

@k8slens/extensions / Exports / Renderer / LensExtension

"},{"location":"extensions/api/classes/Renderer.LensExtension/#class-lensextension","title":"Class: LensExtension","text":"

Renderer.LensExtension

"},{"location":"extensions/api/classes/Renderer.LensExtension/#hierarchy","title":"Hierarchy","text":"
  • LensExtension

\u21b3 LensExtension

"},{"location":"extensions/api/classes/Renderer.LensExtension/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.LensExtension/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.LensExtension/#properties","title":"Properties","text":"
  • additionalCategoryColumns
  • appPreferenceTabs
  • appPreferences
  • catalogEntityDetailItems
  • clusterFrameComponents
  • clusterPageMenus
  • clusterPages
  • commands
  • customCategoryViews
  • entitySettings
  • globalPages
  • id
  • isBundled
  • kubeObjectDetailItems
  • kubeObjectHandlers
  • kubeObjectMenuItems
  • kubeObjectStatusTexts
  • kubeWorkloadsOverviewItems
  • manifest
  • manifestPath
  • protocolHandlers
  • statusBarItems
  • topBarItems
  • welcomeBanners
  • welcomeMenus
"},{"location":"extensions/api/classes/Renderer.LensExtension/#accessors","title":"Accessors","text":"
  • description
  • isEnabled
  • name
  • sanitizedExtensionId
  • storeName
  • version
"},{"location":"extensions/api/classes/Renderer.LensExtension/#methods","title":"Methods","text":"
  • activate
  • addCatalogCategoryFilter
  • addCatalogFilter
  • disable
  • enable
  • getExtensionFileFolder
  • isEnabledForCluster
  • navigate
  • onActivate
  • onDeactivate
"},{"location":"extensions/api/classes/Renderer.LensExtension/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.LensExtension/#constructor","title":"constructor","text":"

\u2022 new LensExtension(extension)

"},{"location":"extensions/api/classes/Renderer.LensExtension/#parameters","title":"Parameters","text":"Name Type extension InstalledExtension"},{"location":"extensions/api/classes/Renderer.LensExtension/#overrides","title":"Overrides","text":"

LensExtension.constructor

"},{"location":"extensions/api/classes/Renderer.LensExtension/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.LensExtension/#additionalcategorycolumns","title":"additionalCategoryColumns","text":"

\u2022 additionalCategoryColumns: AdditionalCategoryColumnRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#apppreferencetabs","title":"appPreferenceTabs","text":"

\u2022 appPreferenceTabs: AppPreferenceTabRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#apppreferences","title":"appPreferences","text":"

\u2022 appPreferences: AppPreferenceRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#catalogentitydetailitems","title":"catalogEntityDetailItems","text":"

\u2022 catalogEntityDetailItems: CatalogEntityDetailRegistration<CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>>[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#clusterframecomponents","title":"clusterFrameComponents","text":"

\u2022 clusterFrameComponents: ClusterFrameChildComponent[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#clusterpagemenus","title":"clusterPageMenus","text":"

\u2022 clusterPageMenus: ClusterPageMenuRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#clusterpages","title":"clusterPages","text":"

\u2022 clusterPages: PageRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#commands","title":"commands","text":"

\u2022 commands: CommandRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#customcategoryviews","title":"customCategoryViews","text":"

\u2022 customCategoryViews: CustomCategoryViewRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#entitysettings","title":"entitySettings","text":"

\u2022 entitySettings: EntitySettingRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#globalpages","title":"globalPages","text":"

\u2022 globalPages: PageRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#id","title":"id","text":"

\u2022 Readonly id: string

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from","title":"Inherited from","text":"

LensExtension.id

"},{"location":"extensions/api/classes/Renderer.LensExtension/#isbundled","title":"isBundled","text":"

\u2022 Readonly isBundled: boolean

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_1","title":"Inherited from","text":"

LensExtension.isBundled

"},{"location":"extensions/api/classes/Renderer.LensExtension/#kubeobjectdetailitems","title":"kubeObjectDetailItems","text":"

\u2022 kubeObjectDetailItems: KubeObjectDetailRegistration<KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>>[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#kubeobjecthandlers","title":"kubeObjectHandlers","text":"

\u2022 kubeObjectHandlers: KubeObjectHandlerRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#kubeobjectmenuitems","title":"kubeObjectMenuItems","text":"

\u2022 kubeObjectMenuItems: KubeObjectMenuRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#kubeobjectstatustexts","title":"kubeObjectStatusTexts","text":"

\u2022 kubeObjectStatusTexts: KubeObjectStatusRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#kubeworkloadsoverviewitems","title":"kubeWorkloadsOverviewItems","text":"

\u2022 kubeWorkloadsOverviewItems: WorkloadsOverviewDetailRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#manifest","title":"manifest","text":"

\u2022 Readonly manifest: LensExtensionManifest

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_2","title":"Inherited from","text":"

LensExtension.manifest

"},{"location":"extensions/api/classes/Renderer.LensExtension/#manifestpath","title":"manifestPath","text":"

\u2022 Readonly manifestPath: string

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_3","title":"Inherited from","text":"

LensExtension.manifestPath

"},{"location":"extensions/api/classes/Renderer.LensExtension/#protocolhandlers","title":"protocolHandlers","text":"

\u2022 protocolHandlers: ProtocolHandlerRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_4","title":"Inherited from","text":"

LensExtension.protocolHandlers

"},{"location":"extensions/api/classes/Renderer.LensExtension/#statusbaritems","title":"statusBarItems","text":"

\u2022 statusBarItems: StatusBarRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#topbaritems","title":"topBarItems","text":"

\u2022 topBarItems: TopBarRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#welcomebanners","title":"welcomeBanners","text":"

\u2022 welcomeBanners: WelcomeBannerRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#welcomemenus","title":"welcomeMenus","text":"

\u2022 welcomeMenus: WelcomeMenuRegistration[]

"},{"location":"extensions/api/classes/Renderer.LensExtension/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.LensExtension/#description","title":"description","text":"

\u2022 get description(): undefined | string

"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns","title":"Returns","text":"

undefined | string

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_5","title":"Inherited from","text":"

LensExtension.description

"},{"location":"extensions/api/classes/Renderer.LensExtension/#isenabled","title":"isEnabled","text":"

\u2022 get isEnabled(): boolean

"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_1","title":"Returns","text":"

boolean

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_6","title":"Inherited from","text":"

LensExtension.isEnabled

"},{"location":"extensions/api/classes/Renderer.LensExtension/#name","title":"name","text":"

\u2022 get name(): string

"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_2","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_7","title":"Inherited from","text":"

LensExtension.name

"},{"location":"extensions/api/classes/Renderer.LensExtension/#sanitizedextensionid","title":"sanitizedExtensionId","text":"

\u2022 get sanitizedExtensionId(): string

"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_3","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_8","title":"Inherited from","text":"

LensExtension.sanitizedExtensionId

"},{"location":"extensions/api/classes/Renderer.LensExtension/#storename","title":"storeName","text":"

\u2022 get storeName(): string

"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_4","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_9","title":"Inherited from","text":"

LensExtension.storeName

"},{"location":"extensions/api/classes/Renderer.LensExtension/#version","title":"version","text":"

\u2022 get version(): string

"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_5","title":"Returns","text":"

string

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_10","title":"Inherited from","text":"

LensExtension.version

"},{"location":"extensions/api/classes/Renderer.LensExtension/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.LensExtension/#activate","title":"activate","text":"

\u25b8 activate(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_6","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_11","title":"Inherited from","text":"

LensExtension.activate

"},{"location":"extensions/api/classes/Renderer.LensExtension/#addcatalogcategoryfilter","title":"addCatalogCategoryFilter","text":"

\u25b8 addCatalogCategoryFilter(fn): Disposer

Add a filtering function for the catalog categories. This will be removed if the extension is disabled.

"},{"location":"extensions/api/classes/Renderer.LensExtension/#parameters_1","title":"Parameters","text":"Name Type Description fn CategoryFilter The function which should return a truthy value for those categories which should be kept."},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_7","title":"Returns","text":"

Disposer

A function to clean up the filter

"},{"location":"extensions/api/classes/Renderer.LensExtension/#addcatalogfilter","title":"addCatalogFilter","text":"

\u25b8 addCatalogFilter(fn): Disposer

Add a filtering function for the catalog entities. This will be removed if the extension is disabled.

"},{"location":"extensions/api/classes/Renderer.LensExtension/#parameters_2","title":"Parameters","text":"Name Type Description fn EntityFilter The function which should return a truthy value for those entities which should be kept."},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_8","title":"Returns","text":"

Disposer

A function to clean up the filter

"},{"location":"extensions/api/classes/Renderer.LensExtension/#disable","title":"disable","text":"

\u25b8 disable(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_9","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_12","title":"Inherited from","text":"

LensExtension.disable

"},{"location":"extensions/api/classes/Renderer.LensExtension/#enable","title":"enable","text":"

\u25b8 enable(): Promise<void>

"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_10","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_13","title":"Inherited from","text":"

LensExtension.enable

"},{"location":"extensions/api/classes/Renderer.LensExtension/#getextensionfilefolder","title":"getExtensionFileFolder","text":"

\u25b8 getExtensionFileFolder(): Promise<string>

getExtensionFileFolder returns the path to an already created folder. This folder is for the sole use of this extension.

Note: there is no security done on this folder, only obfuscation of the folder name.

"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_11","title":"Returns","text":"

Promise<string>

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_14","title":"Inherited from","text":"

LensExtension.getExtensionFileFolder

"},{"location":"extensions/api/classes/Renderer.LensExtension/#isenabledforcluster","title":"isEnabledForCluster","text":"

\u25b8 isEnabledForCluster(cluster): Promise<Boolean>

Defines if extension is enabled for a given cluster. This method is only called when the extension is created within a cluster frame.

The default implementation is to return true

Deprecated

Switch to using \"enabled\" or \"visible\" properties in each registration together with activeCluster

"},{"location":"extensions/api/classes/Renderer.LensExtension/#parameters_3","title":"Parameters","text":"Name Type cluster KubernetesCluster<KubernetesClusterMetadata, KubernetesClusterStatus, KubernetesClusterSpec>"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_12","title":"Returns","text":"

Promise<Boolean>

"},{"location":"extensions/api/classes/Renderer.LensExtension/#navigate","title":"navigate","text":"

\u25b8 navigate(pageId?, params?): Promise<void>

"},{"location":"extensions/api/classes/Renderer.LensExtension/#parameters_4","title":"Parameters","text":"Name Type pageId? string params? object"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_13","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/classes/Renderer.LensExtension/#onactivate","title":"onActivate","text":"

\u25b8 Protected onActivate(): void | Promise<void>

"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_14","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_15","title":"Inherited from","text":"

LensExtension.onActivate

"},{"location":"extensions/api/classes/Renderer.LensExtension/#ondeactivate","title":"onDeactivate","text":"

\u25b8 Protected onDeactivate(): void | Promise<void>

"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_15","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/classes/Renderer.LensExtension/#inherited-from_16","title":"Inherited from","text":"

LensExtension.onDeactivate

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/","title":"Renderer.Navigation.PageParam","text":"

@k8slens/extensions / Exports / Renderer / Navigation / PageParam

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#class-pageparamvalue","title":"Class: PageParam<Value>","text":"

Renderer.Navigation.PageParam

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#type-parameters","title":"Type parameters","text":"Name Type Value any"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#constructors","title":"Constructors","text":"
  • constructor
"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#properties","title":"Properties","text":"
  • dependencies
  • isMulti
  • name
"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#accessors","title":"Accessors","text":"
  • defaultValue
"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#methods","title":"Methods","text":"
  • clear
  • get
  • getRaw
  • parse
  • set
  • setRaw
  • stringify
  • toString
"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#constructors_1","title":"Constructors","text":""},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#constructor","title":"constructor","text":"

\u2022 new PageParam<Value>(dependencies, init)

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#type-parameters_1","title":"Type parameters","text":"Name Type Value any"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#parameters","title":"Parameters","text":"Name Type dependencies PageParamDependencies init PageParamInit<Value>"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#dependencies","title":"dependencies","text":"

\u2022 Protected Readonly dependencies: PageParamDependencies

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#ismulti","title":"isMulti","text":"

\u2022 Readonly isMulti: boolean

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#name","title":"name","text":"

\u2022 Readonly name: string

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#defaultvalue","title":"defaultValue","text":"

\u2022 get defaultValue(): undefined | Value

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#returns","title":"Returns","text":"

undefined | Value

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#clear","title":"clear","text":"

\u25b8 clear(): void

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#get","title":"get","text":"

\u25b8 get(): Value

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#returns_2","title":"Returns","text":"

Value

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#getraw","title":"getRaw","text":"

\u25b8 getRaw(): string | string[]

Get stringified raw value(s) from document.location.search

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#returns_3","title":"Returns","text":"

string | string[]

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#parse","title":"parse","text":"

\u25b8 parse(values): Value

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#parameters_1","title":"Parameters","text":"Name Type values string | string[]"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#returns_4","title":"Returns","text":"

Value

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#set","title":"set","text":"

\u25b8 set(value, \u00abdestructured\u00bb?): void

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#parameters_2","title":"Parameters","text":"Name Type value Value \u00abdestructured\u00bb Object \u203a\u00a0mergeGlobals? boolean \u203a\u00a0replaceHistory? boolean"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#setraw","title":"setRaw","text":"

\u25b8 setRaw(value): void

Set stringified raw value(s) and update document.location.search

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#parameters_3","title":"Parameters","text":"Name Type value string | string[]"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#returns_6","title":"Returns","text":"

void

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#stringify","title":"stringify","text":"

\u25b8 stringify(value?): string[]

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#parameters_4","title":"Parameters","text":"Name Type value? Value"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#returns_7","title":"Returns","text":"

string[]

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#tostring","title":"toString","text":"

\u25b8 toString(\u00abdestructured\u00bb?): string

"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#parameters_5","title":"Parameters","text":"Name Type \u00abdestructured\u00bb Object \u203a\u00a0mergeGlobals? boolean \u203a\u00a0value? Value"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#returns_8","title":"Returns","text":"

string

"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/","title":"Renderer.Component.NotificationStatus","text":"

@k8slens/extensions / Exports / Renderer / Component / NotificationStatus

"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#enumeration-notificationstatus","title":"Enumeration: NotificationStatus","text":"

Renderer.Component.NotificationStatus

"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#enumeration-members","title":"Enumeration Members","text":"
  • ERROR
  • INFO
  • OK
"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#enumeration-members_1","title":"Enumeration Members","text":""},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#error","title":"ERROR","text":"

\u2022 ERROR = \"error\"

"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#info","title":"INFO","text":"

\u2022 INFO = \"info\"

"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#ok","title":"OK","text":"

\u2022 OK = \"ok\"

"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/","title":"Renderer.Component.TooltipPosition","text":"

@k8slens/extensions / Exports / Renderer / Component / TooltipPosition

"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#enumeration-tooltipposition","title":"Enumeration: TooltipPosition","text":"

Renderer.Component.TooltipPosition

"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#enumeration-members","title":"Enumeration Members","text":"
  • BOTTOM
  • BOTTOM_LEFT
  • BOTTOM_RIGHT
  • LEFT
  • RIGHT
  • TOP
  • TOP_LEFT
  • TOP_RIGHT
"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#enumeration-members_1","title":"Enumeration Members","text":""},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#bottom","title":"BOTTOM","text":"

\u2022 BOTTOM = \"bottom\"

"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#bottom_left","title":"BOTTOM_LEFT","text":"

\u2022 BOTTOM_LEFT = \"bottom_left\"

"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#bottom_right","title":"BOTTOM_RIGHT","text":"

\u2022 BOTTOM_RIGHT = \"bottom_right\"

"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#left","title":"LEFT","text":"

\u2022 LEFT = \"left\"

"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#right","title":"RIGHT","text":"

\u2022 RIGHT = \"right\"

"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#top","title":"TOP","text":"

\u2022 TOP = \"top\"

"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#top_left","title":"TOP_LEFT","text":"

\u2022 TOP_LEFT = \"top_left\"

"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#top_right","title":"TOP_RIGHT","text":"

\u2022 TOP_RIGHT = \"top_right\"

"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/","title":"Renderer.K8sApi.KubeObjectStatusLevel","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / KubeObjectStatusLevel

"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#enumeration-kubeobjectstatuslevel","title":"Enumeration: KubeObjectStatusLevel","text":"

Renderer.K8sApi.KubeObjectStatusLevel

"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#enumeration-members","title":"Enumeration Members","text":"
  • CRITICAL
  • INFO
  • WARNING
"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#enumeration-members_1","title":"Enumeration Members","text":""},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#critical","title":"CRITICAL","text":"

\u2022 CRITICAL = 3

"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#info","title":"INFO","text":"

\u2022 INFO = 1

"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#warning","title":"WARNING","text":"

\u2022 WARNING = 2

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/","title":"Common.Catalog.CatalogCategoryEvents","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogCategoryEvents

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#interface-catalogcategoryevents","title":"Interface: CatalogCategoryEvents","text":"

Common.Catalog.CatalogCategoryEvents

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#properties","title":"Properties","text":"
  • catalogAddMenu
  • contextMenuOpen
  • load
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#catalogaddmenu","title":"catalogAddMenu","text":"

\u2022 catalogAddMenu: (context: CatalogEntityAddMenuContext) => void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#type-declaration","title":"Type declaration","text":"

\u25b8 (context): void

This event will be emitted when the catalog add menu is opened and is the way to added entries to that menu.

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#parameters","title":"Parameters","text":"Name Type context CatalogEntityAddMenuContext"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#contextmenuopen","title":"contextMenuOpen","text":"

\u2022 contextMenuOpen: (entity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>, context: CatalogEntityContextMenuContext) => void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (entity, context): void

This event will be emitted when the context menu for an entity is declared by this category is opened.

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#parameters_1","title":"Parameters","text":"Name Type entity CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec> context CatalogEntityContextMenuContext"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#load","title":"load","text":"

\u2022 load: () => void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (): void

This event will be emitted when the category is loaded in the catalog view.

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/","title":"Common.Catalog.CatalogCategoryMetadata","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogCategoryMetadata

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/#interface-catalogcategorymetadata","title":"Interface: CatalogCategoryMetadata","text":"

Common.Catalog.CatalogCategoryMetadata

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/#properties","title":"Properties","text":"
  • icon
  • name
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/#icon","title":"icon","text":"

\u2022 Readonly icon: string

Either an <svg> or one of the provided svg names from NamedSvg

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/#name","title":"name","text":"

\u2022 Readonly name: string

The name of your category. The category can be searched for by this value. This will also be used for the catalog menu.

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/","title":"Common.Catalog.CatalogCategorySpec","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogCategorySpec

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#interface-catalogcategoryspec","title":"Interface: CatalogCategorySpec","text":"

Common.Catalog.CatalogCategorySpec

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#properties","title":"Properties","text":"
  • displayColumns
  • group
  • names
  • versions
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#displaycolumns","title":"displayColumns","text":"

\u2022 Optional Readonly displayColumns: CategoryColumnRegistration[]

These are the columns used for displaying entities when in the catalog.

If this is not provided then some default columns will be used, similar in scope to the columns in the \"Browse\" view.

Even if you provide columns, a \"Name\" column will be provided as well with priority: 0.

These columns will not be used in the \"Browse\" view.

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#group","title":"group","text":"

\u2022 Readonly group: string

The grouping for for the category. This MUST be a DNS label.

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#names","title":"names","text":"

\u2022 Readonly names: Object

This is the concerning the category

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#type-declaration","title":"Type declaration","text":"Name Type Description kind string The kind of entity that this category is for. This value MUST be a DNS label and MUST be equal to the kind fields that are produced by the .versions.[] \\| .entityClass fields."},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#versions","title":"versions","text":"

\u2022 Readonly versions: CatalogCategoryVersion[]

The specific versions of the constructors.

NOTE: the field .apiVersion after construction MUST match {.group}/{.versions.[] | .name}. For example, if group = \"entity.k8slens.dev\" and there is an entry in .versions with name = \"v1alpha1\" then the resulting .apiVersion MUST be entity.k8slens.dev/v1alpha1

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/","title":"Common.Catalog.CatalogCategoryVersion","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogCategoryVersion

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/#interface-catalogcategoryversion","title":"Interface: CatalogCategoryVersion","text":"

Common.Catalog.CatalogCategoryVersion

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/#properties","title":"Properties","text":"
  • entityClass
  • name
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/#entityclass","title":"entityClass","text":"

\u2022 Readonly entityClass: CatalogEntityConstructor<CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>>

The constructor for the entities.

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/#name","title":"name","text":"

\u2022 Readonly name: string

The specific version that the associated constructor is for. This MUST be a DNS label and SHOULD be of the form vN, vNalphaY, or vNbetaY where N and Y are both integers greater than 0.

Examples: The following are valid values for this field. - v1 - v1beta1 - v1alpha2 - v3beta2

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/","title":"Common.Catalog.CatalogEntityActionContext","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogEntityActionContext

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#interface-catalogentityactioncontext","title":"Interface: CatalogEntityActionContext","text":"

Common.Catalog.CatalogEntityActionContext

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#properties","title":"Properties","text":"
  • navigate
  • setCommandPaletteContext
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#navigate","title":"navigate","text":"

\u2022 navigate: (url: string) => void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#type-declaration","title":"Type declaration","text":"

\u25b8 (url): void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#parameters","title":"Parameters","text":"Name Type url string"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#setcommandpalettecontext","title":"setCommandPaletteContext","text":"

\u2022 setCommandPaletteContext: (context?: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>) => void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (context?): void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#parameters_1","title":"Parameters","text":"Name Type context? CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/","title":"Common.Catalog.CatalogEntityAddMenu","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogEntityAddMenu

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#interface-catalogentityaddmenu","title":"Interface: CatalogEntityAddMenu","text":"

Common.Catalog.CatalogEntityAddMenu

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#hierarchy","title":"Hierarchy","text":"
  • CatalogEntityContextMenu

\u21b3 CatalogEntityAddMenu

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#properties","title":"Properties","text":"
  • confirm
  • defaultAction
  • icon
  • onClick
  • title
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#confirm","title":"confirm","text":"

\u2022 Optional confirm: Object

Confirm click with a message

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#type-declaration","title":"Type declaration","text":"Name Type message string"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#inherited-from","title":"Inherited from","text":"

CatalogEntityContextMenu.confirm

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#defaultaction","title":"defaultAction","text":"

\u2022 Optional defaultAction: boolean

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#icon","title":"icon","text":"

\u2022 icon: string

Menu icon

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#overrides","title":"Overrides","text":"

CatalogEntityContextMenu.icon

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#onclick","title":"onClick","text":"

\u2022 onClick: () => void | Promise<void>

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (): void | Promise<void>

OnClick handler

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#returns","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#inherited-from_1","title":"Inherited from","text":"

CatalogEntityContextMenu.onClick

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#title","title":"title","text":"

\u2022 title: string

Menu title

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#inherited-from_2","title":"Inherited from","text":"

CatalogEntityContextMenu.title

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/","title":"Common.Catalog.CatalogEntityAddMenuContext","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogEntityAddMenuContext

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#interface-catalogentityaddmenucontext","title":"Interface: CatalogEntityAddMenuContext","text":"

Common.Catalog.CatalogEntityAddMenuContext

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#properties","title":"Properties","text":"
  • menuItems
  • navigate
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#menuitems","title":"menuItems","text":"

\u2022 menuItems: CatalogEntityAddMenu[]

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#navigate","title":"navigate","text":"

\u2022 navigate: (url: string) => void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#type-declaration","title":"Type declaration","text":"

\u25b8 (url): void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#parameters","title":"Parameters","text":"Name Type url string"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/","title":"Common.Catalog.CatalogEntityContextMenu","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogEntityContextMenu

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#interface-catalogentitycontextmenu","title":"Interface: CatalogEntityContextMenu","text":"

Common.Catalog.CatalogEntityContextMenu

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#hierarchy","title":"Hierarchy","text":"
  • CatalogEntityContextMenu

\u21b3 CatalogEntityAddMenu

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#properties","title":"Properties","text":"
  • confirm
  • icon
  • onClick
  • title
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#confirm","title":"confirm","text":"

\u2022 Optional confirm: Object

Confirm click with a message

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#type-declaration","title":"Type declaration","text":"Name Type message string"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#icon","title":"icon","text":"

\u2022 Optional icon: string

Menu icon

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#onclick","title":"onClick","text":"

\u2022 onClick: () => void | Promise<void>

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (): void | Promise<void>

OnClick handler

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#returns","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#title","title":"title","text":"

\u2022 title: string

Menu title

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/","title":"Common.Catalog.CatalogEntityContextMenuContext","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogEntityContextMenuContext

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/#interface-catalogentitycontextmenucontext","title":"Interface: CatalogEntityContextMenuContext","text":"

Common.Catalog.CatalogEntityContextMenuContext

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/#properties","title":"Properties","text":"
  • menuItems
  • navigate
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/#menuitems","title":"menuItems","text":"

\u2022 menuItems: CatalogEntityContextMenu[]

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/#navigate","title":"navigate","text":"

\u2022 navigate: CatalogEntityContextMenuNavigate

Navigate to the specified pathname

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/","title":"Common.Catalog.CatalogEntityContextMenuNavigate","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogEntityContextMenuNavigate

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/#interface-catalogentitycontextmenunavigate","title":"Interface: CatalogEntityContextMenuNavigate","text":"

Common.Catalog.CatalogEntityContextMenuNavigate

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/#callable","title":"Callable","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/#catalogentitycontextmenunavigate","title":"CatalogEntityContextMenuNavigate","text":"

\u25b8 CatalogEntityContextMenuNavigate(pathname, forceMainFrame?): void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/#parameters","title":"Parameters","text":"Name Type Description pathname string The location to navigate to in the main iframe forceMainFrame? boolean -"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/#catalogentitycontextmenunavigate_1","title":"CatalogEntityContextMenuNavigate","text":"

\u25b8 CatalogEntityContextMenuNavigate(pathname, forceMainFrame): void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/#parameters_1","title":"Parameters","text":"Name Type Description pathname string The location to navigate to in the current iframe. Useful for when called within the cluster frame forceMainFrame false -"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/","title":"Common.Catalog.CatalogEntityData","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogEntityData

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#interface-catalogentitydatametadata-status-spec","title":"Interface: CatalogEntityData<Metadata, Status, Spec>","text":"

Common.Catalog.CatalogEntityData

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends CatalogEntityMetadata = CatalogEntityMetadata Status extends CatalogEntityStatus = CatalogEntityStatus Spec extends CatalogEntitySpec = CatalogEntitySpec"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#properties","title":"Properties","text":"
  • metadata
  • spec
  • status
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#metadata","title":"metadata","text":"

\u2022 metadata: Metadata

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#spec","title":"spec","text":"

\u2022 spec: Spec

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#status","title":"status","text":"

\u2022 status: Status

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/","title":"Common.Catalog.CatalogEntityKindData","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogEntityKindData

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#interface-catalogentitykinddata","title":"Interface: CatalogEntityKindData","text":"

Common.Catalog.CatalogEntityKindData

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#implemented-by","title":"Implemented by","text":"
  • CatalogEntity
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#properties","title":"Properties","text":"
  • apiVersion
  • kind
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#apiversion","title":"apiVersion","text":"

\u2022 Readonly apiVersion: string

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#kind","title":"kind","text":"

\u2022 Readonly kind: string

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/","title":"Common.Catalog.CatalogEntityMetadata","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogEntityMetadata

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#interface-catalogentitymetadata","title":"Interface: CatalogEntityMetadata","text":"

Common.Catalog.CatalogEntityMetadata

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#hierarchy","title":"Hierarchy","text":"
  • EntityMetadataObject

\u21b3 CatalogEntityMetadata

\u21b3\u21b3 KubernetesClusterMetadata

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#properties","title":"Properties","text":"
  • description
  • labels
  • name
  • shortName
  • source
  • uid
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#description","title":"description","text":"

\u2022 Optional description: string

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#labels","title":"labels","text":"

\u2022 labels: Partial<Record<string, string>>

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#name","title":"name","text":"

\u2022 name: string

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#shortname","title":"shortName","text":"

\u2022 Optional shortName: string

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#source","title":"source","text":"

\u2022 Optional source: string

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#uid","title":"uid","text":"

\u2022 uid: string

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/","title":"Common.Catalog.CatalogEntitySettingsContext","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogEntitySettingsContext

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/#interface-catalogentitysettingscontext","title":"Interface: CatalogEntitySettingsContext","text":"

Common.Catalog.CatalogEntitySettingsContext

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/#properties","title":"Properties","text":"
  • menuItems
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/#menuitems","title":"menuItems","text":"

\u2022 menuItems: CatalogEntityContextMenu[]

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/","title":"Common.Catalog.CatalogEntitySettingsMenu","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogEntitySettingsMenu

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#interface-catalogentitysettingsmenu","title":"Interface: CatalogEntitySettingsMenu","text":"

Common.Catalog.CatalogEntitySettingsMenu

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#properties","title":"Properties","text":"
  • components
  • group
  • title
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#components","title":"components","text":"

\u2022 components: Object

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#type-declaration","title":"Type declaration","text":"Name Type View ComponentType<any>"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#group","title":"group","text":"

\u2022 Optional group: string

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#title","title":"title","text":"

\u2022 title: string

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/","title":"Common.Catalog.CatalogEntityStatus","text":"

@k8slens/extensions / Exports / Common / Catalog / CatalogEntityStatus

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#interface-catalogentitystatus","title":"Interface: CatalogEntityStatus","text":"

Common.Catalog.CatalogEntityStatus

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#hierarchy","title":"Hierarchy","text":"
  • CatalogEntityStatus

\u21b3 WebLinkStatus

\u21b3 KubernetesClusterStatus

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#properties","title":"Properties","text":"
  • active
  • enabled
  • message
  • phase
  • reason
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#active","title":"active","text":"

\u2022 Optional active: boolean

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#enabled","title":"enabled","text":"

\u2022 Optional enabled: boolean

Default

true\n
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#message","title":"message","text":"

\u2022 Optional message: string

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#phase","title":"phase","text":"

\u2022 phase: string

"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#reason","title":"reason","text":"

\u2022 Optional reason: string

"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/","title":"Common.Catalog.CategoryColumnRegistration","text":"

@k8slens/extensions / Exports / Common / Catalog / CategoryColumnRegistration

"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#interface-categorycolumnregistration","title":"Interface: CategoryColumnRegistration","text":"

Common.Catalog.CategoryColumnRegistration

"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#hierarchy","title":"Hierarchy","text":"
  • CategoryColumnRegistration

\u21b3 AdditionalCategoryColumnRegistration

"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#properties","title":"Properties","text":"
  • id
  • priority
  • renderCell
  • searchFilter
  • sortCallback
  • titleProps
"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#id","title":"id","text":"

\u2022 id: string

This value MUST to be unique to your extension

"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#priority","title":"priority","text":"

\u2022 Optional priority: number

The sorting order value.

Default

50\n
"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#rendercell","title":"renderCell","text":"

\u2022 renderCell: (entity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>) => ReactNode

"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#type-declaration","title":"Type declaration","text":"

\u25b8 (entity): ReactNode

This function will be called to generate the cells (on demand) for the column

"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#parameters","title":"Parameters","text":"Name Type entity CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#returns","title":"Returns","text":"

ReactNode

"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#searchfilter","title":"searchFilter","text":"

\u2022 Optional searchFilter: (entity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>) => string | string[]

"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (entity): string | string[]

If provided then searching is supported on this column and this function will be called to determine if the current search string matches for this row.

"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#parameters_1","title":"Parameters","text":"Name Type entity CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#returns_1","title":"Returns","text":"

string | string[]

"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#sortcallback","title":"sortCallback","text":"

\u2022 Optional sortCallback: (entity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>) => string | number | (string | number)[]

"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (entity): string | number | (string | number)[]

If provided then the column will support sorting and this function will be called to determine a row's ordering.

strings are sorted ahead of numbers, and arrays determine ordering between equal elements of the previous index.

"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#parameters_2","title":"Parameters","text":"Name Type entity CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#returns_2","title":"Returns","text":"

string | number | (string | number)[]

"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#titleprops","title":"titleProps","text":"

\u2022 titleProps: TitleCellProps

This function will be used to generate the columns title cell.

"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/","title":"Common.Catalog.GeneralEntitySpec","text":"

@k8slens/extensions / Exports / Common / Catalog / GeneralEntitySpec

"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#interface-generalentityspec","title":"Interface: GeneralEntitySpec","text":"

Common.Catalog.GeneralEntitySpec

"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#hierarchy","title":"Hierarchy","text":"
  • CatalogEntitySpec

\u21b3 GeneralEntitySpec

"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#properties","title":"Properties","text":"
  • icon
  • path
"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#icon","title":"icon","text":"

\u2022 Optional icon: Object

"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#type-declaration","title":"Type declaration","text":"Name Type background? string material? string"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#path","title":"path","text":"

\u2022 path: string

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/","title":"Common.Catalog.KubernetesClusterMetadata","text":"

@k8slens/extensions / Exports / Common / Catalog / KubernetesClusterMetadata

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#interface-kubernetesclustermetadata","title":"Interface: KubernetesClusterMetadata","text":"

Common.Catalog.KubernetesClusterMetadata

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#hierarchy","title":"Hierarchy","text":"
  • CatalogEntityMetadata

\u21b3 KubernetesClusterMetadata

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#properties","title":"Properties","text":"
  • description
  • distro
  • kubeVersion
  • labels
  • name
  • shortName
  • source
  • uid
"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#description","title":"description","text":"

\u2022 Optional description: string

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#inherited-from","title":"Inherited from","text":"

CatalogEntityMetadata.description

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#distro","title":"distro","text":"

\u2022 Optional distro: string

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#kubeversion","title":"kubeVersion","text":"

\u2022 Optional kubeVersion: string

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#labels","title":"labels","text":"

\u2022 labels: Partial<Record<string, string>>

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#inherited-from_1","title":"Inherited from","text":"

CatalogEntityMetadata.labels

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#name","title":"name","text":"

\u2022 name: string

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#inherited-from_2","title":"Inherited from","text":"

CatalogEntityMetadata.name

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#shortname","title":"shortName","text":"

\u2022 Optional shortName: string

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#inherited-from_3","title":"Inherited from","text":"

CatalogEntityMetadata.shortName

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#source","title":"source","text":"

\u2022 Optional source: string

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#inherited-from_4","title":"Inherited from","text":"

CatalogEntityMetadata.source

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#uid","title":"uid","text":"

\u2022 uid: string

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#inherited-from_5","title":"Inherited from","text":"

CatalogEntityMetadata.uid

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/","title":"Common.Catalog.KubernetesClusterPrometheusMetrics","text":"

@k8slens/extensions / Exports / Common / Catalog / KubernetesClusterPrometheusMetrics

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#interface-kubernetesclusterprometheusmetrics","title":"Interface: KubernetesClusterPrometheusMetrics","text":"

Common.Catalog.KubernetesClusterPrometheusMetrics

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#properties","title":"Properties","text":"
  • address
  • type
"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#address","title":"address","text":"

\u2022 Optional address: Object

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#type-declaration","title":"Type declaration","text":"Name Type namespace string port number prefix string service string"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#type","title":"type","text":"

\u2022 Optional type: string

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/","title":"Common.Catalog.KubernetesClusterSpec","text":"

@k8slens/extensions / Exports / Common / Catalog / KubernetesClusterSpec

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#interface-kubernetesclusterspec","title":"Interface: KubernetesClusterSpec","text":"

Common.Catalog.KubernetesClusterSpec

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#hierarchy","title":"Hierarchy","text":"
  • CatalogEntitySpec

\u21b3 KubernetesClusterSpec

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#properties","title":"Properties","text":"
  • accessibleNamespaces
  • icon
  • kubeconfigContext
  • kubeconfigPath
  • metrics
"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#accessiblenamespaces","title":"accessibleNamespaces","text":"

\u2022 Optional accessibleNamespaces: string[]

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#icon","title":"icon","text":"

\u2022 Optional icon: Object

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#type-declaration","title":"Type declaration","text":"Name Type background? string material? string src? string"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#kubeconfigcontext","title":"kubeconfigContext","text":"

\u2022 kubeconfigContext: string

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#kubeconfigpath","title":"kubeconfigPath","text":"

\u2022 kubeconfigPath: string

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#metrics","title":"metrics","text":"

\u2022 Optional metrics: Object

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#type-declaration_1","title":"Type declaration","text":"Name Type prometheus? KubernetesClusterPrometheusMetrics source string"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/","title":"Common.Catalog.KubernetesClusterStatus","text":"

@k8slens/extensions / Exports / Common / Catalog / KubernetesClusterStatus

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#interface-kubernetesclusterstatus","title":"Interface: KubernetesClusterStatus","text":"

Common.Catalog.KubernetesClusterStatus

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#hierarchy","title":"Hierarchy","text":"
  • CatalogEntityStatus

\u21b3 KubernetesClusterStatus

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#properties","title":"Properties","text":"
  • active
  • enabled
  • message
  • phase
  • reason
"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#active","title":"active","text":"

\u2022 Optional active: boolean

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#inherited-from","title":"Inherited from","text":"

CatalogEntityStatus.active

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#enabled","title":"enabled","text":"

\u2022 Optional enabled: boolean

Default

true\n
"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#inherited-from_1","title":"Inherited from","text":"

CatalogEntityStatus.enabled

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#message","title":"message","text":"

\u2022 Optional message: string

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#inherited-from_2","title":"Inherited from","text":"

CatalogEntityStatus.message

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#phase","title":"phase","text":"

\u2022 phase: string

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#inherited-from_3","title":"Inherited from","text":"

CatalogEntityStatus.phase

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#reason","title":"reason","text":"

\u2022 Optional reason: string

"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#inherited-from_4","title":"Inherited from","text":"

CatalogEntityStatus.reason

"},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/","title":"Common.Catalog.TitleCellProps","text":"

@k8slens/extensions / Exports / Common / Catalog / TitleCellProps

"},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/#interface-titlecellprops","title":"Interface: TitleCellProps","text":"

Common.Catalog.TitleCellProps

These are the supported props for the title cell

"},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/#properties","title":"Properties","text":"
  • className
  • data-testid
  • title
"},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/#data-testid","title":"data-testid","text":"

\u2022 Optional data-testid: string

"},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/#title","title":"title","text":"

\u2022 title: string

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkSpec/","title":"Common.Catalog.WebLinkSpec","text":"

@k8slens/extensions / Exports / Common / Catalog / WebLinkSpec

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkSpec/#interface-weblinkspec","title":"Interface: WebLinkSpec","text":"

Common.Catalog.WebLinkSpec

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkSpec/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkSpec/#properties","title":"Properties","text":"
  • url
"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkSpec/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkSpec/#url","title":"url","text":"

\u2022 url: string

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/","title":"Common.Catalog.WebLinkStatus","text":"

@k8slens/extensions / Exports / Common / Catalog / WebLinkStatus

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#interface-weblinkstatus","title":"Interface: WebLinkStatus","text":"

Common.Catalog.WebLinkStatus

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#hierarchy","title":"Hierarchy","text":"
  • CatalogEntityStatus

\u21b3 WebLinkStatus

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#properties","title":"Properties","text":"
  • active
  • enabled
  • message
  • phase
  • reason
"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#active","title":"active","text":"

\u2022 Optional active: boolean

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#inherited-from","title":"Inherited from","text":"

CatalogEntityStatus.active

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#enabled","title":"enabled","text":"

\u2022 Optional enabled: boolean

Default

true\n
"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#inherited-from_1","title":"Inherited from","text":"

CatalogEntityStatus.enabled

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#message","title":"message","text":"

\u2022 Optional message: string

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#inherited-from_2","title":"Inherited from","text":"

CatalogEntityStatus.message

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#phase","title":"phase","text":"

\u2022 phase: WebLinkStatusPhase

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#overrides","title":"Overrides","text":"

CatalogEntityStatus.phase

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#reason","title":"reason","text":"

\u2022 Optional reason: string

"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#inherited-from_3","title":"Inherited from","text":"

CatalogEntityStatus.reason

"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/","title":"Common.EventBus.AppEvent","text":"

@k8slens/extensions / Exports / Common / EventBus / AppEvent

"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#interface-appevent","title":"Interface: AppEvent","text":"

Common.EventBus.AppEvent

Data for telemetry

"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#properties","title":"Properties","text":"
  • action
  • destination
  • name
  • params
"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#action","title":"action","text":"

\u2022 action: string

"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#destination","title":"destination","text":"

\u2022 Optional destination: string

"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#name","title":"name","text":"

\u2022 name: string

"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#params","title":"params","text":"

\u2022 Optional params: Record<string, any>

"},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/","title":"Common.EventBus.EventEmitterOptions","text":"

@k8slens/extensions / Exports / Common / EventBus / EventEmitterOptions

"},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/#interface-eventemitteroptions","title":"Interface: EventEmitterOptions","text":"

Common.EventBus.EventEmitterOptions

"},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/#properties","title":"Properties","text":"
  • once
  • prepend
"},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/#once","title":"once","text":"

\u2022 Optional once: boolean

"},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/#prepend","title":"prepend","text":"

\u2022 Optional prepend: boolean

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/","title":"Common.LensExtensionManifest","text":"

@k8slens/extensions / Exports / Common / LensExtensionManifest

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#interface-lensextensionmanifest","title":"Interface: LensExtensionManifest","text":"

Common.LensExtensionManifest

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#hierarchy","title":"Hierarchy","text":"
  • BundledLensExtensionManifest

\u21b3 LensExtensionManifest

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#properties","title":"Properties","text":"
  • description
  • engines
  • main
  • name
  • publishConfig
  • renderer
  • storeName
  • version
"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#description","title":"description","text":"

\u2022 Optional description: string

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#inherited-from","title":"Inherited from","text":"

BundledLensExtensionManifest.description

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#engines","title":"engines","text":"

\u2022 engines: Object

Supported Lens version engine by extension could be defined in manifest.engines.lens Only MAJOR.MINOR version is taken in consideration.

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#index-signature","title":"Index signature","text":"

\u25aa [x: string]: string | undefined

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#type-declaration","title":"Type declaration","text":"Name Type lens string"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#main","title":"main","text":"

\u2022 Optional main: string

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#name","title":"name","text":"

\u2022 name: string

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#inherited-from_1","title":"Inherited from","text":"

BundledLensExtensionManifest.name

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#publishconfig","title":"publishConfig","text":"

\u2022 Optional publishConfig: Partial<Record<string, string>>

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#inherited-from_2","title":"Inherited from","text":"

BundledLensExtensionManifest.publishConfig

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#renderer","title":"renderer","text":"

\u2022 Optional renderer: string

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#storename","title":"storeName","text":"

\u2022 Optional storeName: string

Specify extension name used for persisting data. Useful if extension is renamed but the data should not be lost.

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#inherited-from_3","title":"Inherited from","text":"

BundledLensExtensionManifest.storeName

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#version","title":"version","text":"

\u2022 version: string

"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#inherited-from_4","title":"Inherited from","text":"

BundledLensExtensionManifest.version

"},{"location":"extensions/api/interfaces/Common.Logger/","title":"Common.Logger","text":"

@k8slens/extensions / Exports / Common / Logger

"},{"location":"extensions/api/interfaces/Common.Logger/#interface-logger","title":"Interface: Logger","text":"

Common.Logger

Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.

"},{"location":"extensions/api/interfaces/Common.Logger/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Logger/#properties","title":"Properties","text":"
  • debug
  • error
  • info
  • silly
  • warn
"},{"location":"extensions/api/interfaces/Common.Logger/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Logger/#debug","title":"debug","text":"

\u2022 debug: (message: string, ...args: any) => void

"},{"location":"extensions/api/interfaces/Common.Logger/#type-declaration","title":"Type declaration","text":"

\u25b8 (message, ...args): void

"},{"location":"extensions/api/interfaces/Common.Logger/#parameters","title":"Parameters","text":"Name Type message string ...args any"},{"location":"extensions/api/interfaces/Common.Logger/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Logger/#error","title":"error","text":"

\u2022 error: (message: string, ...args: any) => void

"},{"location":"extensions/api/interfaces/Common.Logger/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (message, ...args): void

"},{"location":"extensions/api/interfaces/Common.Logger/#parameters_1","title":"Parameters","text":"Name Type message string ...args any"},{"location":"extensions/api/interfaces/Common.Logger/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Logger/#info","title":"info","text":"

\u2022 info: (message: string, ...args: any) => void

"},{"location":"extensions/api/interfaces/Common.Logger/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (message, ...args): void

"},{"location":"extensions/api/interfaces/Common.Logger/#parameters_2","title":"Parameters","text":"Name Type message string ...args any"},{"location":"extensions/api/interfaces/Common.Logger/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Logger/#silly","title":"silly","text":"

\u2022 silly: (message: string, ...args: any) => void

"},{"location":"extensions/api/interfaces/Common.Logger/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (message, ...args): void

"},{"location":"extensions/api/interfaces/Common.Logger/#parameters_3","title":"Parameters","text":"Name Type message string ...args any"},{"location":"extensions/api/interfaces/Common.Logger/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Logger/#warn","title":"warn","text":"

\u2022 warn: (message: string, ...args: any) => void

"},{"location":"extensions/api/interfaces/Common.Logger/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (message, ...args): void

"},{"location":"extensions/api/interfaces/Common.Logger/#parameters_4","title":"Parameters","text":"Name Type message string ...args any"},{"location":"extensions/api/interfaces/Common.Logger/#returns_4","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/","title":"Common.Store.ExtensionStoreParams","text":"

@k8slens/extensions / Exports / Common / Store / ExtensionStoreParams

"},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#interface-extensionstoreparamst","title":"Interface: ExtensionStoreParams<T>","text":"

Common.Store.ExtensionStoreParams

"},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#type-parameters","title":"Type parameters","text":"Name Type T extends object"},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#hierarchy","title":"Hierarchy","text":"
  • Omit<PersistentStorageParams<T>, \"migrations\" | \"cwd\" | \"fromStore\" | \"toJSON\">

\u21b3 ExtensionStoreParams

"},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#properties","title":"Properties","text":"
  • configName
  • cwd
  • migrations
  • syncOptions
"},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#configname","title":"configName","text":"

\u2022 Readonly configName: string

"},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#inherited-from","title":"Inherited from","text":"

Omit.configName

"},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#cwd","title":"cwd","text":"

\u2022 Optional cwd: string

"},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#migrations","title":"migrations","text":"

\u2022 Optional migrations: Migrations<T>

"},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#syncoptions","title":"syncOptions","text":"

\u2022 Optional Readonly syncOptions: Object

"},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#type-declaration","title":"Type declaration","text":"Name Type equals? IEqualsComparer<T> fireImmediately? boolean"},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#inherited-from_1","title":"Inherited from","text":"

Omit.syncOptions

"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/","title":"Common.Store.PersistentStorageParams","text":"

@k8slens/extensions / Exports / Common / Store / PersistentStorageParams

"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#interface-persistentstorageparamst","title":"Interface: PersistentStorageParams<T>","text":"

Common.Store.PersistentStorageParams

"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#type-parameters","title":"Type parameters","text":"Name Type T extends object"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#hierarchy","title":"Hierarchy","text":"
  • Omit<Options<T>, \"migrations\">

\u21b3 PersistentStorageParams

"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#properties","title":"Properties","text":"
  • configName
  • migrations
  • syncOptions
"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#methods","title":"Methods","text":"
  • fromStore
  • toJSON
"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#configname","title":"configName","text":"

\u2022 Readonly configName: string

"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#overrides","title":"Overrides","text":"

Omit.configName

"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#migrations","title":"migrations","text":"

\u2022 Optional Readonly migrations: Partial<Record<string, (store: MigrationStore) => void>>

"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#syncoptions","title":"syncOptions","text":"

\u2022 Optional Readonly syncOptions: Object

"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#type-declaration","title":"Type declaration","text":"Name Type equals? IEqualsComparer<T> fireImmediately? boolean"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#fromstore","title":"fromStore","text":"

\u25b8 fromStore(data): void

fromStore is called internally when a child class syncs with the file system.

Note: This function must be synchronous.

"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#parameters","title":"Parameters","text":"Name Type Description data Partial<T> the parsed information read from the stored JSON file"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#tojson","title":"toJSON","text":"

\u25b8 toJSON(): T

toJSON is called when syncing the store to the filesystem. It should produce a JSON serializable object representation of the current state.

It is recommended that a round trip is valid. Namely, calling this.fromStore(this.toJSON()) shouldn't change the state.

"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#returns_1","title":"Returns","text":"

T

"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/","title":"Common.Types.AppPreferenceComponents","text":"

@k8slens/extensions / Exports / Common / Types / AppPreferenceComponents

"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/#interface-apppreferencecomponents","title":"Interface: AppPreferenceComponents","text":"

Common.Types.AppPreferenceComponents

"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/#properties","title":"Properties","text":"
  • Hint
  • Input
"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/#hint","title":"Hint","text":"

\u2022 Hint: ComponentType<any>

"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/#input","title":"Input","text":"

\u2022 Input: ComponentType<any>

"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/","title":"Common.Types.AppPreferenceRegistration","text":"

@k8slens/extensions / Exports / Common / Types / AppPreferenceRegistration

"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#interface-apppreferenceregistration","title":"Interface: AppPreferenceRegistration","text":"

Common.Types.AppPreferenceRegistration

"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#properties","title":"Properties","text":"
  • components
  • id
  • showInPreferencesTab
  • title
"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#components","title":"components","text":"

\u2022 components: AppPreferenceComponents

"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#id","title":"id","text":"

\u2022 Optional id: string

"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#showinpreferencestab","title":"showInPreferencesTab","text":"

\u2022 Optional showInPreferencesTab: string

"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#title","title":"title","text":"

\u2022 title: string

"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/","title":"Common.Types.ClusterPageMenuComponents","text":"

@k8slens/extensions / Exports / Common / Types / ClusterPageMenuComponents

"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/#interface-clusterpagemenucomponents","title":"Interface: ClusterPageMenuComponents","text":"

Common.Types.ClusterPageMenuComponents

"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/#properties","title":"Properties","text":"
  • Icon
"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/#icon","title":"Icon","text":"

\u2022 Icon: ComponentType<IconProps>

"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/","title":"Common.Types.ClusterPageMenuRegistration","text":"

@k8slens/extensions / Exports / Common / Types / ClusterPageMenuRegistration

"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#interface-clusterpagemenuregistration","title":"Interface: ClusterPageMenuRegistration","text":"

Common.Types.ClusterPageMenuRegistration

"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#properties","title":"Properties","text":"
  • components
  • id
  • orderNumber
  • parentId
  • target
  • title
  • visible
"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#components","title":"components","text":"

\u2022 components: ClusterPageMenuComponents

"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#id","title":"id","text":"

\u2022 Optional id: string

"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#ordernumber","title":"orderNumber","text":"

\u2022 Optional orderNumber: number

"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#parentid","title":"parentId","text":"

\u2022 Optional parentId: string

"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#target","title":"target","text":"

\u2022 Optional target: PageTarget

"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#title","title":"title","text":"

\u2022 title: ReactNode

"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#visible","title":"visible","text":"

\u2022 Optional visible: IComputedValue<boolean>

"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/","title":"Common.Types.CustomCategoryViewComponents","text":"

@k8slens/extensions / Exports / Common / Types / CustomCategoryViewComponents

"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/#interface-customcategoryviewcomponents","title":"Interface: CustomCategoryViewComponents","text":"

Common.Types.CustomCategoryViewComponents

The components for the category view.

"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/#properties","title":"Properties","text":"
  • View
"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/#view","title":"View","text":"

\u2022 View: ComponentType<CustomCategoryViewProps>

"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewProps/","title":"Common.Types.CustomCategoryViewProps","text":"

@k8slens/extensions / Exports / Common / Types / CustomCategoryViewProps

"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewProps/#interface-customcategoryviewprops","title":"Interface: CustomCategoryViewProps","text":"

Common.Types.CustomCategoryViewProps

The props for CustomCategoryViewComponents.View

"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewProps/#properties","title":"Properties","text":"
  • category
"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewProps/#category","title":"category","text":"

\u2022 category: CatalogCategory

The category instance itself

"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/","title":"Common.Types.CustomCategoryViewRegistration","text":"

@k8slens/extensions / Exports / Common / Types / CustomCategoryViewRegistration

"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#interface-customcategoryviewregistration","title":"Interface: CustomCategoryViewRegistration","text":"

Common.Types.CustomCategoryViewRegistration

This is the type used to declare additional views for a specific category

"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#properties","title":"Properties","text":"
  • components
  • group
  • kind
  • priority
"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#components","title":"components","text":"

\u2022 components: CustomCategoryViewComponents

The components for this registration

"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#group","title":"group","text":"

\u2022 group: string

The catalog entity group that is declared by the category for this registration

e.g. - \"entity.k8slens.dev\"

"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#kind","title":"kind","text":"

\u2022 kind: string

The catalog entity kind that is declared by the category for this registration

e.g. - \"KubernetesCluster\"

"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#priority","title":"priority","text":"

\u2022 Optional priority: number

The sorting order value. Used to determine the total order of the views.

Default

50\n
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/","title":"Common.Types.KubeObjectContextMenuItem","text":"

@k8slens/extensions / Exports / Common / Types / KubeObjectContextMenuItem

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#interface-kubeobjectcontextmenuitem","title":"Interface: KubeObjectContextMenuItem","text":"

Common.Types.KubeObjectContextMenuItem

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#properties","title":"Properties","text":"
  • icon
  • id
  • onClick
  • title
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#icon","title":"icon","text":"

\u2022 icon: string | BaseIconProps

If the type is string then it is shorthand for material

This is required because this item can be either rendered as a context menu or as a toolbar in the kube object details page.

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#id","title":"id","text":"

\u2022 Optional id: string

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#onclick","title":"onClick","text":"

\u2022 onClick: (obj: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>) => void

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#type-declaration","title":"Type declaration","text":"

\u25b8 (obj): void

The action when clicked

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#parameters","title":"Parameters","text":"Name Type obj KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#title","title":"title","text":"

\u2022 title: string

The title text for the menu item or the hover text for the icon.

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/","title":"Common.Types.KubeObjectDetailComponents","text":"

@k8slens/extensions / Exports / Common / Types / KubeObjectDetailComponents

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/#interface-kubeobjectdetailcomponentst","title":"Interface: KubeObjectDetailComponents<T>","text":"

Common.Types.KubeObjectDetailComponents

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/#type-parameters","title":"Type parameters","text":"Name Type T extends KubeObject = KubeObject"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/#properties","title":"Properties","text":"
  • Details
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/#details","title":"Details","text":"

\u2022 Details: ComponentType<KubeObjectDetailsProps<T>>

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/","title":"Common.Types.KubeObjectDetailRegistration","text":"

@k8slens/extensions / Exports / Common / Types / KubeObjectDetailRegistration

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#interface-kubeobjectdetailregistrationt","title":"Interface: KubeObjectDetailRegistration<T>","text":"

Common.Types.KubeObjectDetailRegistration

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#type-parameters","title":"Type parameters","text":"Name Type T extends KubeObject = KubeObject"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#properties","title":"Properties","text":"
  • apiVersions
  • components
  • kind
  • priority
  • visible
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#apiversions","title":"apiVersions","text":"

\u2022 apiVersions: string[]

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#components","title":"components","text":"

\u2022 components: KubeObjectDetailComponents<T>

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#priority","title":"priority","text":"

\u2022 Optional priority: number

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#visible","title":"visible","text":"

\u2022 Optional visible: IComputedValue<boolean>

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectHandlers/","title":"Common.Types.KubeObjectHandlers","text":"

@k8slens/extensions / Exports / Common / Types / KubeObjectHandlers

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectHandlers/#interface-kubeobjecthandlers","title":"Interface: KubeObjectHandlers","text":"

Common.Types.KubeObjectHandlers

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectHandlers/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectHandlers/#properties","title":"Properties","text":"
  • onContextMenuOpen
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectHandlers/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectHandlers/#oncontextmenuopen","title":"onContextMenuOpen","text":"

\u2022 onContextMenuOpen: KubeObjectOnContextMenuOpen

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/","title":"Common.Types.KubeObjectMenuComponents","text":"

@k8slens/extensions / Exports / Common / Types / KubeObjectMenuComponents

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/#interface-kubeobjectmenucomponents","title":"Interface: KubeObjectMenuComponents","text":"

Common.Types.KubeObjectMenuComponents

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/#properties","title":"Properties","text":"
  • MenuItem
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/#menuitem","title":"MenuItem","text":"

\u2022 MenuItem: ComponentType<KubeObjectMenuItemProps>

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/","title":"Common.Types.KubeObjectMenuRegistration","text":"

@k8slens/extensions / Exports / Common / Types / KubeObjectMenuRegistration

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#interface-kubeobjectmenuregistration","title":"Interface: KubeObjectMenuRegistration","text":"

Common.Types.KubeObjectMenuRegistration

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#properties","title":"Properties","text":"
  • apiVersions
  • components
  • kind
  • visible
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#apiversions","title":"apiVersions","text":"

\u2022 apiVersions: string[]

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#components","title":"components","text":"

\u2022 components: KubeObjectMenuComponents

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#visible","title":"visible","text":"

\u2022 Optional visible: IComputedValue<boolean>

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/","title":"Common.Types.KubeObjectOnContextMenuOpenContext","text":"

@k8slens/extensions / Exports / Common / Types / KubeObjectOnContextMenuOpenContext

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#interface-kubeobjectoncontextmenuopencontext","title":"Interface: KubeObjectOnContextMenuOpenContext","text":"

Common.Types.KubeObjectOnContextMenuOpenContext

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#properties","title":"Properties","text":"
  • menuItems
  • navigate
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#menuitems","title":"menuItems","text":"

\u2022 Readonly menuItems: IObservableArray<KubeObjectContextMenuItem>

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#navigate","title":"navigate","text":"

\u2022 navigate: (location: string) => void

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#type-declaration","title":"Type declaration","text":"

\u25b8 (location): void

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#parameters","title":"Parameters","text":"Name Type location string"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/","title":"Common.Types.KubeObjectStatusRegistration","text":"

@k8slens/extensions / Exports / Common / Types / KubeObjectStatusRegistration

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#interface-kubeobjectstatusregistration","title":"Interface: KubeObjectStatusRegistration","text":"

Common.Types.KubeObjectStatusRegistration

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#properties","title":"Properties","text":"
  • apiVersions
  • kind
  • resolve
  • visible
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#apiversions","title":"apiVersions","text":"

\u2022 apiVersions: string[]

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#resolve","title":"resolve","text":"

\u2022 resolve: (object: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>) => KubeObjectStatus

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#type-declaration","title":"Type declaration","text":"

\u25b8 (object): KubeObjectStatus

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#parameters","title":"Parameters","text":"Name Type object KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#returns","title":"Returns","text":"

KubeObjectStatus

"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#visible","title":"visible","text":"

\u2022 Optional visible: IComputedValue<boolean>

"},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/","title":"Common.Types.PageComponentProps","text":"

@k8slens/extensions / Exports / Common / Types / PageComponentProps

"},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/#interface-pagecomponentpropsp","title":"Interface: PageComponentProps<P>","text":"

Common.Types.PageComponentProps

"},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/#type-parameters","title":"Type parameters","text":"Name Type P extends PageParams = {}"},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/#properties","title":"Properties","text":"
  • params
"},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/#params","title":"params","text":"

\u2022 Optional params: { [N in string | number | symbol]: PageParam<P[N]> }

"},{"location":"extensions/api/interfaces/Common.Types.PageComponents/","title":"Common.Types.PageComponents","text":"

@k8slens/extensions / Exports / Common / Types / PageComponents

"},{"location":"extensions/api/interfaces/Common.Types.PageComponents/#interface-pagecomponents","title":"Interface: PageComponents","text":"

Common.Types.PageComponents

"},{"location":"extensions/api/interfaces/Common.Types.PageComponents/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.PageComponents/#properties","title":"Properties","text":"
  • Page
"},{"location":"extensions/api/interfaces/Common.Types.PageComponents/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.PageComponents/#page","title":"Page","text":"

\u2022 Page: ComponentType<any>

"},{"location":"extensions/api/interfaces/Common.Types.PageParams/","title":"Common.Types.PageParams","text":"

@k8slens/extensions / Exports / Common / Types / PageParams

"},{"location":"extensions/api/interfaces/Common.Types.PageParams/#interface-pageparamsv","title":"Interface: PageParams<V>","text":"

Common.Types.PageParams

"},{"location":"extensions/api/interfaces/Common.Types.PageParams/#type-parameters","title":"Type parameters","text":"Name Type V any"},{"location":"extensions/api/interfaces/Common.Types.PageParams/#indexable","title":"Indexable","text":"

\u25aa [paramName: string]: V

"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/","title":"Common.Types.PageRegistration","text":"

@k8slens/extensions / Exports / Common / Types / PageRegistration

"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#interface-pageregistration","title":"Interface: PageRegistration","text":"

Common.Types.PageRegistration

"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#properties","title":"Properties","text":"
  • components
  • enabled
  • id
  • params
"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#components","title":"components","text":"

\u2022 components: PageComponents

"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#enabled","title":"enabled","text":"

\u2022 Optional enabled: IComputedValue<boolean>

"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#id","title":"id","text":"

\u2022 Optional id: string

Page ID, part of extension's page url, must be unique within same extension When not provided, first registered page without \"id\" would be used for page-menus without target.pageId for same extension

"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#params","title":"params","text":"

\u2022 Optional params: PageParams<string | Omit<PageParamInit<any>, \"name\" | \"prefix\">>

"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/","title":"Common.Types.PageTarget","text":"

@k8slens/extensions / Exports / Common / Types / PageTarget

"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#interface-pagetarget","title":"Interface: PageTarget","text":"

Common.Types.PageTarget

"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#properties","title":"Properties","text":"
  • extensionId
  • pageId
  • params
"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#extensionid","title":"extensionId","text":"

\u2022 Optional extensionId: string

"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#pageid","title":"pageId","text":"

\u2022 Optional pageId: string

"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#params","title":"params","text":"

\u2022 Optional params: PageParams<any>

"},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/","title":"Common.Types.ProtocolHandlerRegistration","text":"

@k8slens/extensions / Exports / Common / Types / ProtocolHandlerRegistration

"},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/#interface-protocolhandlerregistration","title":"Interface: ProtocolHandlerRegistration","text":"

Common.Types.ProtocolHandlerRegistration

ProtocolHandlerRegistration is the data required for an extension to register a handler to a specific path or dynamic path.

"},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/#properties","title":"Properties","text":"
  • handler
  • pathSchema
"},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/#handler","title":"handler","text":"

\u2022 handler: ProtocolRouteHandler

"},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/#pathschema","title":"pathSchema","text":"

\u2022 pathSchema: string

"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteHandler/","title":"Common.Types.ProtocolRouteHandler","text":"

@k8slens/extensions / Exports / Common / Types / ProtocolRouteHandler

"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteHandler/#interface-protocolroutehandler","title":"Interface: ProtocolRouteHandler","text":"

Common.Types.ProtocolRouteHandler

"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteHandler/#callable","title":"Callable","text":""},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteHandler/#protocolroutehandler","title":"ProtocolRouteHandler","text":"

\u25b8 ProtocolRouteHandler(params): void

RouteHandler represents the function signature of the handler function for lens:// protocol routing.

"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteHandler/#parameters","title":"Parameters","text":"Name Type params ProtocolRouteParams"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteHandler/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/","title":"Common.Types.ProtocolRouteParams","text":"

@k8slens/extensions / Exports / Common / Types / ProtocolRouteParams

"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#interface-protocolrouteparams","title":"Interface: ProtocolRouteParams","text":"

Common.Types.ProtocolRouteParams

The collection of the dynamic parts of a URI which initiated a lens:// protocol request

"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#properties","title":"Properties","text":"
  • pathname
  • search
  • tail
"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#pathname","title":"pathname","text":"

\u2022 pathname: Record<string, undefined | string>

the matching parts of the path. The dynamic parts of the URI path.

"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#search","title":"search","text":"

\u2022 search: Record<string, undefined | string>

the parts of the URI query string

"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#tail","title":"tail","text":"

\u2022 Optional tail: string

if the most specific path schema that is matched does not cover the whole of the URI's path. Then this field will be set to the remaining path segments.

Example:

If the path schema /landing/:type is the matched schema for the URI /landing/soft/easy then this field will be set to \"/easy\".

"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/","title":"Common.Types.RegisteredPage","text":"

@k8slens/extensions / Exports / Common / Types / RegisteredPage

"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#interface-registeredpage","title":"Interface: RegisteredPage","text":"

Common.Types.RegisteredPage

"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#properties","title":"Properties","text":"
  • components
  • extensionId
  • id
  • params
  • url
"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#components","title":"components","text":"

\u2022 components: PageComponents

"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#extensionid","title":"extensionId","text":"

\u2022 extensionId: string

"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#id","title":"id","text":"

\u2022 id: string

"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#params","title":"params","text":"

\u2022 params: PageParams<PageParam<any>>

"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#url","title":"url","text":"

\u2022 url: string

"},{"location":"extensions/api/interfaces/Common.Types.ShellEnvContext/","title":"Common.Types.ShellEnvContext","text":"

@k8slens/extensions / Exports / Common / Types / ShellEnvContext

"},{"location":"extensions/api/interfaces/Common.Types.ShellEnvContext/#interface-shellenvcontext","title":"Interface: ShellEnvContext","text":"

Common.Types.ShellEnvContext

"},{"location":"extensions/api/interfaces/Common.Types.ShellEnvContext/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.ShellEnvContext/#properties","title":"Properties","text":"
  • catalogEntity
"},{"location":"extensions/api/interfaces/Common.Types.ShellEnvContext/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.ShellEnvContext/#catalogentity","title":"catalogEntity","text":"

\u2022 catalogEntity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>

"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/","title":"Common.Types.StatusBarRegistration","text":"

@k8slens/extensions / Exports / Common / Types / StatusBarRegistration

"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#interface-statusbarregistration","title":"Interface: StatusBarRegistration","text":"

Common.Types.StatusBarRegistration

The type for registering status bar items from the LensRendererExtension

"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#properties","title":"Properties","text":"
  • components
  • item
  • visible
"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#components","title":"components","text":"

\u2022 Optional components: StatusBarComponents

The newer API, allows for registering a component instead of a ReactNode

"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#item","title":"item","text":"

\u2022 Optional item: ReactNode | () => ReactNode

Deprecated

use components instead

"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#visible","title":"visible","text":"

\u2022 Optional visible: IComputedValue<boolean>

If specified, controls item visibility

"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/","title":"Common.Types.TrayMenuRegistration","text":"

@k8slens/extensions / Exports / Common / Types / TrayMenuRegistration

"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#interface-traymenuregistration","title":"Interface: TrayMenuRegistration","text":"

Common.Types.TrayMenuRegistration

"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#properties","title":"Properties","text":"
  • click
  • enabled
  • id
  • label
  • submenu
  • toolTip
  • type
  • visible
"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#click","title":"click","text":"

\u2022 Optional click: (menuItem: TrayMenuRegistration) => void

"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#type-declaration","title":"Type declaration","text":"

\u25b8 (menuItem): void

"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#parameters","title":"Parameters","text":"Name Type menuItem TrayMenuRegistration"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#enabled","title":"enabled","text":"

\u2022 Optional enabled: boolean | IComputedValue<boolean>

"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#id","title":"id","text":"

\u2022 Optional id: string

"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#label","title":"label","text":"

\u2022 Optional label: string | IComputedValue<string>

"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#submenu","title":"submenu","text":"

\u2022 Optional submenu: TrayMenuRegistration[]

"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#tooltip","title":"toolTip","text":"

\u2022 Optional toolTip: string

"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#type","title":"type","text":"

\u2022 Optional type: \"submenu\" | \"normal\" | \"separator\"

"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#visible","title":"visible","text":"

\u2022 Optional visible: IComputedValue<boolean>

"},{"location":"extensions/api/interfaces/Common.Util.Disposable/","title":"Common.Util.Disposable","text":"

@k8slens/extensions / Exports / Common / Util / Disposable

"},{"location":"extensions/api/interfaces/Common.Util.Disposable/#interface-disposable","title":"Interface: Disposable","text":"

Common.Util.Disposable

"},{"location":"extensions/api/interfaces/Common.Util.Disposable/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Util.Disposable/#methods","title":"Methods","text":"
  • dispose
"},{"location":"extensions/api/interfaces/Common.Util.Disposable/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Common.Util.Disposable/#dispose","title":"dispose","text":"

\u25b8 dispose(): void

"},{"location":"extensions/api/interfaces/Common.Util.Disposable/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Util.Disposer/","title":"Common.Util.Disposer","text":"

@k8slens/extensions / Exports / Common / Util / Disposer

"},{"location":"extensions/api/interfaces/Common.Util.Disposer/#interface-disposer","title":"Interface: Disposer","text":"

Common.Util.Disposer

"},{"location":"extensions/api/interfaces/Common.Util.Disposer/#hierarchy","title":"Hierarchy","text":"
  • Disposer

\u21b3 ExtendableDisposer

"},{"location":"extensions/api/interfaces/Common.Util.Disposer/#callable","title":"Callable","text":""},{"location":"extensions/api/interfaces/Common.Util.Disposer/#disposer","title":"Disposer","text":"

\u25b8 Disposer(): void

"},{"location":"extensions/api/interfaces/Common.Util.Disposer/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/","title":"Common.Util.ExtendableDisposer","text":"

@k8slens/extensions / Exports / Common / Util / ExtendableDisposer

"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#interface-extendabledisposer","title":"Interface: ExtendableDisposer","text":"

Common.Util.ExtendableDisposer

"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#hierarchy","title":"Hierarchy","text":"
  • Disposer

\u21b3 ExtendableDisposer

"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#callable","title":"Callable","text":""},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#extendabledisposer","title":"ExtendableDisposer","text":"

\u25b8 ExtendableDisposer(): void

"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#methods","title":"Methods","text":"
  • push
"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#push","title":"push","text":"

\u25b8 push(...values): void

"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#parameters","title":"Parameters","text":"Name Type ...values (Disposer | ExtendableDisposer | Disposable)[]"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/","title":"Main.Catalog.CatalogEntityRegistry","text":"

@k8slens/extensions / Exports / Main / Catalog / CatalogEntityRegistry

"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#interface-catalogentityregistry","title":"Interface: CatalogEntityRegistry","text":"

Main.Catalog.CatalogEntityRegistry

"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#methods","title":"Methods","text":"
  • getItemsForApiKind
"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#getitemsforapikind","title":"getItemsForApiKind","text":"

\u25b8 getItemsForApiKind(apiVersion, kind): CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>[]

"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#parameters","title":"Parameters","text":"Name Type apiVersion string kind string"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#returns","title":"Returns","text":"

CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>[]

\u25b8 getItemsForApiKind<T>(apiVersion, kind): T[]

Deprecated

use a cast instead of a unbounded type parameter

"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#type-parameters","title":"Type parameters","text":"Name Type T extends CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec, T>"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#parameters_1","title":"Parameters","text":"Name Type apiVersion string kind string"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#returns_1","title":"Returns","text":"

T[]

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/","title":"Main.K8sApi.BaseKubeJsonApiObjectMetadata","text":"

@k8slens/extensions / Exports / Main / K8sApi / BaseKubeJsonApiObjectMetadata

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#interface-basekubejsonapiobjectmetadatanamespaced","title":"Interface: BaseKubeJsonApiObjectMetadata<Namespaced>","text":"

Main.K8sApi.BaseKubeJsonApiObjectMetadata

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#type-parameters","title":"Type parameters","text":"Name Type Namespaced extends KubeObjectScope"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#indexable","title":"Indexable","text":"

\u25aa [key: string]: unknown

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#properties","title":"Properties","text":"
  • annotations
  • clusterName
  • creationTimestamp
  • deletionGracePeriodSeconds
  • deletionTimestamp
  • finalizers
  • generateName
  • generation
  • labels
  • managedFields
  • name
  • namespace
  • ownerReferences
  • resourceVersion
  • selfLink
  • uid
"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#annotations","title":"annotations","text":"

\u2022 Optional annotations: Partial<Record<string, string>>

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

More info: http://kubernetes.io/docs/user-guide/annotations

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#clustername","title":"clusterName","text":"

\u2022 Optional clusterName: string

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 and api server is going to ignore it if set in create or update request.

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#creationtimestamp","title":"creationTimestamp","text":"

\u2022 Optional Readonly creationTimestamp: string

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#deletiongraceperiodseconds","title":"deletionGracePeriodSeconds","text":"

\u2022 Optional Readonly deletionGracePeriodSeconds: number

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened.

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#deletiontimestamp","title":"deletionTimestamp","text":"

\u2022 Optional Readonly deletionTimestamp: string

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#finalizers","title":"finalizers","text":"

\u2022 Optional finalizers: string[]

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#generatename","title":"generateName","text":"

\u2022 Optional generateName: string

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#generation","title":"generation","text":"

\u2022 Optional Readonly generation: number

A sequence number representing a specific generation of the desired state. Populated by the system.

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#labels","title":"labels","text":"

\u2022 Optional labels: Partial<Record<string, string>>

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services.

More info: http://kubernetes.io/docs/user-guide/labels

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#managedfields","title":"managedFields","text":"

\u2022 Optional managedFields: unknown[]

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object.

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#name","title":"name","text":"

\u2022 Readonly name: string

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition.

More info: http://kubernetes.io/docs/user-guide/identifiers#names

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#namespace","title":"namespace","text":"

\u2022 Optional Readonly namespace: ScopedNamespace<Namespaced>

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#ownerreferences","title":"ownerReferences","text":"

\u2022 Optional ownerReferences: OwnerReference[]

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#resourceversion","title":"resourceVersion","text":"

\u2022 Optional Readonly resourceVersion: string

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Value must be treated as opaque by clients.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#selflink","title":"selfLink","text":"

\u2022 Optional Readonly selfLink: string

SelfLink is a URL representing this object. Populated by the system.

"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#uid","title":"uid","text":"

\u2022 Optional Readonly uid: string

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system.

More info: http://kubernetes.io/docs/user-guide/identifiers#uids

"},{"location":"extensions/api/interfaces/Main.K8sApi.ExternalKubeApiOptions/","title":"Main.K8sApi.ExternalKubeApiOptions","text":"

@k8slens/extensions / Exports / Main / K8sApi / ExternalKubeApiOptions

"},{"location":"extensions/api/interfaces/Main.K8sApi.ExternalKubeApiOptions/#interface-externalkubeapioptions","title":"Interface: ExternalKubeApiOptions","text":"

Main.K8sApi.ExternalKubeApiOptions

"},{"location":"extensions/api/interfaces/Main.K8sApi.ExternalKubeApiOptions/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.ExternalKubeApiOptions/#properties","title":"Properties","text":"
  • autoRegister
"},{"location":"extensions/api/interfaces/Main.K8sApi.ExternalKubeApiOptions/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.ExternalKubeApiOptions/#autoregister","title":"autoRegister","text":"

\u2022 Optional autoRegister: boolean

If true then on creation of the KubeApiinstance a call to apiManager.registerApi will be made. This is true by default to maintain backwards compatibility.

Setting this to false might make KubeObject's details drawer stop working.

Default

true\n
"},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/","title":"Main.K8sApi.IKubeApiCluster","text":"

@k8slens/extensions / Exports / Main / K8sApi / IKubeApiCluster

"},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/#interface-ikubeapicluster","title":"Interface: IKubeApiCluster","text":"

Main.K8sApi.IKubeApiCluster

Deprecated

This type is unused

"},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/#properties","title":"Properties","text":"
  • metadata
"},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/#metadata","title":"metadata","text":"

\u2022 metadata: Object

"},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/#type-declaration","title":"Type declaration","text":"Name Type uid string"},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/","title":"Main.K8sApi.ILocalKubeApiConfig","text":"

@k8slens/extensions / Exports / Main / K8sApi / ILocalKubeApiConfig

"},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/#interface-ilocalkubeapiconfig","title":"Interface: ILocalKubeApiConfig","text":"

Main.K8sApi.ILocalKubeApiConfig

"},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/#properties","title":"Properties","text":"
  • metadata
"},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/#metadata","title":"metadata","text":"

\u2022 metadata: Object

"},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/#type-declaration","title":"Type declaration","text":"Name Type uid string"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/","title":"Main.K8sApi.IPodContainer","text":"

@k8slens/extensions / Exports / Main / K8sApi / IPodContainer

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#interface-ipodcontainer","title":"Interface: IPodContainer","text":"

Main.K8sApi.IPodContainer

A single application container that you want to run within a pod.

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#properties","title":"Properties","text":"
  • args
  • command
  • env
  • envFrom
  • image
  • imagePullPolicy
  • lifecycle
  • livenessProbe
  • name
  • ports
  • readinessProbe
  • resources
  • securityContext
  • startupProbe
  • stdin
  • stdinOnce
  • terminationMessagePath
  • terminationMessagePolicy
  • tty
  • volumeDevices
  • volumeMounts
  • workingDir
"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#args","title":"args","text":"

\u2022 Optional args: string[]

Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment.

If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\".

Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated.

More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#command","title":"command","text":"

\u2022 Optional command: string[]

Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment.

If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\".

Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated.

More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#env","title":"env","text":"

\u2022 Optional env: EnvVar[]

List of environment variables to set in the container. Cannot be updated.

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#envfrom","title":"envFrom","text":"

\u2022 Optional envFrom: EnvFromSource[]

List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting.

When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#image","title":"image","text":"

\u2022 Optional image: string

Docker image name.

More info: https://kubernetes.io/docs/concepts/containers/images

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#imagepullpolicy","title":"imagePullPolicy","text":"

\u2022 Optional imagePullPolicy: \"Always\" | \"Never\" | \"IfNotPresent\"

Image pull policy. Defaults to \"Always\" if :latest tag is specified, or \"IfNotPresent\" otherwise. Cannot be updated.

More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#lifecycle","title":"lifecycle","text":"

\u2022 Optional lifecycle: Lifecycle

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#livenessprobe","title":"livenessProbe","text":"

\u2022 Optional livenessProbe: Probe

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#name","title":"name","text":"

\u2022 name: string

Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#ports","title":"ports","text":"

\u2022 Optional ports: ContainerPort[]

List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated.

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#readinessprobe","title":"readinessProbe","text":"

\u2022 Optional readinessProbe: Probe

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#resources","title":"resources","text":"

\u2022 Optional resources: ResourceRequirements

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#securitycontext","title":"securityContext","text":"

\u2022 Optional securityContext: SecurityContext

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#startupprobe","title":"startupProbe","text":"

\u2022 Optional startupProbe: Probe

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#stdin","title":"stdin","text":"

\u2022 Optional stdin: boolean

Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF.

Default

false\n
"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#stdinonce","title":"stdinOnce","text":"

\u2022 Optional stdinOnce: boolean

Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions.

If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted.

If this flag is false, a container processes that reads from stdin will never receive an EOF.

Default

false\n
"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#terminationmessagepath","title":"terminationMessagePath","text":"

\u2022 Optional terminationMessagePath: string

Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message.

Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Cannot be updated.

Default

\"/dev/termination-log\"\n
"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#terminationmessagepolicy","title":"terminationMessagePolicy","text":"

\u2022 Optional terminationMessagePolicy: \"File\" | \"FallbackToLogsOnError\"

Indicate how the termination message should be populated.

  • File: will use the contents of terminationMessagePath to populate the container status message on both success and failure.

  • FallbackToLogsOnError: will use the last chunk of container log output if the termination message file is empty and the container exited with an error.

The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Cannot be updated.

Default

\"File\"\n
"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#tty","title":"tty","text":"

\u2022 Optional tty: boolean

Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.

Default

false\n
"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#volumedevices","title":"volumeDevices","text":"

\u2022 Optional volumeDevices: VolumeDevice[]

volumeDevices is the list of block devices to be used by the container.

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#volumemounts","title":"volumeMounts","text":"

\u2022 Optional volumeMounts: VolumeMount[]

Pod volumes to mount into the container's filesystem. Cannot be updated.

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#workingdir","title":"workingDir","text":"

\u2022 Optional workingDir: string

Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/","title":"Main.K8sApi.IPodContainerStatus","text":"

@k8slens/extensions / Exports / Main / K8sApi / IPodContainerStatus

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#interface-ipodcontainerstatus","title":"Interface: IPodContainerStatus","text":"

Main.K8sApi.IPodContainerStatus

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#properties","title":"Properties","text":"
  • containerID
  • image
  • imageID
  • lastState
  • name
  • ready
  • restartCount
  • started
  • state
"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#containerid","title":"containerID","text":"

\u2022 Optional containerID: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#image","title":"image","text":"

\u2022 image: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#imageid","title":"imageID","text":"

\u2022 imageID: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#laststate","title":"lastState","text":"

\u2022 Optional lastState: ContainerState

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#name","title":"name","text":"

\u2022 name: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#ready","title":"ready","text":"

\u2022 ready: boolean

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#restartcount","title":"restartCount","text":"

\u2022 restartCount: number

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#started","title":"started","text":"

\u2022 Optional started: boolean

"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#state","title":"state","text":"

\u2022 Optional state: ContainerState

"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/","title":"Main.K8sApi.IRemoteKubeApiConfig","text":"

@k8slens/extensions / Exports / Main / K8sApi / IRemoteKubeApiConfig

"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#interface-iremotekubeapiconfig","title":"Interface: IRemoteKubeApiConfig","text":"

Main.K8sApi.IRemoteKubeApiConfig

"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#properties","title":"Properties","text":"
  • agent
  • cluster
  • user
"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#agent","title":"agent","text":"

\u2022 Optional agent: Agent

Custom instance of https.agent to use for the requests

Remarks

the custom agent replaced default agent, options skipTLSVerify, clientCertificateData, clientKeyData and caData are ignored.

"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#cluster","title":"cluster","text":"

\u2022 cluster: Object

"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#type-declaration","title":"Type declaration","text":"Name Type caData? string server string skipTLSVerify? boolean"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#user","title":"user","text":"

\u2022 user: Object

"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#type-declaration_1","title":"Type declaration","text":"Name Type clientCertificateData? string clientKeyData? string token? string | () => Promise<string>"},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/","title":"Main.K8sApi.ISecretRef","text":"

@k8slens/extensions / Exports / Main / K8sApi / ISecretRef

"},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/#interface-isecretref","title":"Interface: ISecretRef","text":"

Main.K8sApi.ISecretRef

"},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/#properties","title":"Properties","text":"
  • name
  • namespace
"},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/#name","title":"name","text":"

\u2022 name: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/#namespace","title":"namespace","text":"

\u2022 Optional namespace: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/","title":"Main.K8sApi.IgnoredKubeApiOptions","text":"

@k8slens/extensions / Exports / Main / K8sApi / IgnoredKubeApiOptions

"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#interface-ignoredkubeapioptions","title":"Interface: IgnoredKubeApiOptions","text":"

Main.K8sApi.IgnoredKubeApiOptions

Deprecated

This type is only present for backwards compatible typescript support

"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#properties","title":"Properties","text":"
  • apiBase
  • isNamespaces
  • kind
  • objectConstructor
"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#apibase","title":"apiBase","text":"

\u2022 Optional apiBase: any

Deprecated

this option is overridden and should not be used

"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#isnamespaces","title":"isNamespaces","text":"

\u2022 Optional isNamespaces: any

Deprecated

this option is overridden and should not be used

"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#kind","title":"kind","text":"

\u2022 Optional kind: any

Deprecated

this option is overridden and should not be used

"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#objectconstructor","title":"objectConstructor","text":"

\u2022 Optional objectConstructor: any

Deprecated

this option is overridden and should not be used

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/","title":"Main.K8sApi.KubeJsonApiData","text":"

@k8slens/extensions / Exports / Main / K8sApi / KubeJsonApiData

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#interface-kubejsonapidatametadata-status-spec","title":"Interface: KubeJsonApiData<Metadata, Status, Spec>","text":"

Main.K8sApi.KubeJsonApiData

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#type-parameters","title":"Type parameters","text":"Name Type Metadata extends KubeJsonApiObjectMetadata = KubeJsonApiObjectMetadata Status unknown Spec unknown"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#indexable","title":"Indexable","text":"

\u25aa [otherKeys: string]: unknown

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#properties","title":"Properties","text":"
  • apiVersion
  • kind
  • metadata
  • spec
  • status
"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#metadata","title":"metadata","text":"

\u2022 metadata: Metadata

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#spec","title":"spec","text":"

\u2022 Optional spec: Spec

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#status","title":"status","text":"

\u2022 Optional status: Status

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/","title":"Main.K8sApi.KubeObjectStoreLoadAllParams","text":"

@k8slens/extensions / Exports / Main / K8sApi / KubeObjectStoreLoadAllParams

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#interface-kubeobjectstoreloadallparams","title":"Interface: KubeObjectStoreLoadAllParams","text":"

Main.K8sApi.KubeObjectStoreLoadAllParams

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#properties","title":"Properties","text":"
  • merge
  • namespaces
  • onLoadFailure
  • reqInit
"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#merge","title":"merge","text":"

\u2022 Optional merge: boolean

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#namespaces","title":"namespaces","text":"

\u2022 Optional namespaces: string[]

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#onloadfailure","title":"onLoadFailure","text":"

\u2022 Optional onLoadFailure: OnLoadFailure

A function that is called when listing fails. If set then blocks errors being rejected with

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#reqinit","title":"reqInit","text":"

\u2022 Optional reqInit: RequestInit

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/","title":"Main.K8sApi.KubeObjectStoreLoadingParams","text":"

@k8slens/extensions / Exports / Main / K8sApi / KubeObjectStoreLoadingParams

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#interface-kubeobjectstoreloadingparams","title":"Interface: KubeObjectStoreLoadingParams","text":"

Main.K8sApi.KubeObjectStoreLoadingParams

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#properties","title":"Properties","text":"
  • namespaces
  • onLoadFailure
  • reqInit
"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#namespaces","title":"namespaces","text":"

\u2022 namespaces: string[]

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#onloadfailure","title":"onLoadFailure","text":"

\u2022 Optional onLoadFailure: OnLoadFailure

A function that is called when listing fails. If set then blocks errors being rejected with

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#reqinit","title":"reqInit","text":"

\u2022 Optional reqInit: RequestInit

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/","title":"Main.K8sApi.KubeObjectStoreSubscribeParams","text":"

@k8slens/extensions / Exports / Main / K8sApi / KubeObjectStoreSubscribeParams

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/#interface-kubeobjectstoresubscribeparams","title":"Interface: KubeObjectStoreSubscribeParams","text":"

Main.K8sApi.KubeObjectStoreSubscribeParams

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/#properties","title":"Properties","text":"
  • abortController
  • onLoadFailure
"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/#abortcontroller","title":"abortController","text":"

\u2022 Optional abortController: AbortController

An optional parent abort controller

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/#onloadfailure","title":"onLoadFailure","text":"

\u2022 Optional onLoadFailure: OnLoadFailure

A function that is called when listing fails. If set then blocks errors being rejected with

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/","title":"Main.K8sApi.KubeStatusData","text":"

@k8slens/extensions / Exports / Main / K8sApi / KubeStatusData

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#interface-kubestatusdata","title":"Interface: KubeStatusData","text":"

Main.K8sApi.KubeStatusData

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#properties","title":"Properties","text":"
  • apiVersion
  • code
  • kind
  • message
  • reason
  • status
"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#code","title":"code","text":"

\u2022 code: number

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#message","title":"message","text":"

\u2022 Optional message: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#reason","title":"reason","text":"

\u2022 Optional reason: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#status","title":"status","text":"

\u2022 Optional status: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/","title":"Main.K8sApi.OwnerReference","text":"

@k8slens/extensions / Exports / Main / K8sApi / OwnerReference

"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#interface-ownerreference","title":"Interface: OwnerReference","text":"

Main.K8sApi.OwnerReference

"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#properties","title":"Properties","text":"
  • apiVersion
  • blockOwnerDeletion
  • controller
  • kind
  • name
  • uid
"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#apiversion","title":"apiVersion","text":"

\u2022 apiVersion: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#blockownerdeletion","title":"blockOwnerDeletion","text":"

\u2022 Optional blockOwnerDeletion: boolean

"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#controller","title":"controller","text":"

\u2022 Optional controller: boolean

"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#kind","title":"kind","text":"

\u2022 kind: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#name","title":"name","text":"

\u2022 name: string

"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#uid","title":"uid","text":"

\u2022 uid: string

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/","title":"Renderer.Component.AdditionalCategoryColumnRegistration","text":"

@k8slens/extensions / Exports / Renderer / Component / AdditionalCategoryColumnRegistration

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#interface-additionalcategorycolumnregistration","title":"Interface: AdditionalCategoryColumnRegistration","text":"

Renderer.Component.AdditionalCategoryColumnRegistration

This is the type used to declare new catalog category columns

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#hierarchy","title":"Hierarchy","text":"
  • CategoryColumnRegistration

\u21b3 AdditionalCategoryColumnRegistration

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#properties","title":"Properties","text":"
  • group
  • id
  • kind
  • priority
  • renderCell
  • searchFilter
  • sortCallback
  • titleProps
"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#group","title":"group","text":"

\u2022 group: string

The catalog entity group that is declared by the category for this registration

e.g. - \"entity.k8slens.dev\"

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#id","title":"id","text":"

\u2022 id: string

This value MUST to be unique to your extension

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#inherited-from","title":"Inherited from","text":"

CategoryColumnRegistration.id

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#kind","title":"kind","text":"

\u2022 kind: string

The catalog entity kind that is declared by the category for this registration

e.g. - \"KubernetesCluster\"

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#priority","title":"priority","text":"

\u2022 Optional priority: number

The sorting order value.

Default

50\n
"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#inherited-from_1","title":"Inherited from","text":"

CategoryColumnRegistration.priority

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#rendercell","title":"renderCell","text":"

\u2022 renderCell: (entity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>) => ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#type-declaration","title":"Type declaration","text":"

\u25b8 (entity): ReactNode

This function will be called to generate the cells (on demand) for the column

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#parameters","title":"Parameters","text":"Name Type entity CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#returns","title":"Returns","text":"

ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#inherited-from_2","title":"Inherited from","text":"

CategoryColumnRegistration.renderCell

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#searchfilter","title":"searchFilter","text":"

\u2022 Optional searchFilter: (entity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>) => string | string[]

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (entity): string | string[]

If provided then searching is supported on this column and this function will be called to determine if the current search string matches for this row.

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#parameters_1","title":"Parameters","text":"Name Type entity CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#returns_1","title":"Returns","text":"

string | string[]

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#inherited-from_3","title":"Inherited from","text":"

CategoryColumnRegistration.searchFilter

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#sortcallback","title":"sortCallback","text":"

\u2022 Optional sortCallback: (entity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>) => string | number | (string | number)[]

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (entity): string | number | (string | number)[]

If provided then the column will support sorting and this function will be called to determine a row's ordering.

strings are sorted ahead of numbers, and arrays determine ordering between equal elements of the previous index.

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#parameters_2","title":"Parameters","text":"Name Type entity CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#returns_2","title":"Returns","text":"

string | number | (string | number)[]

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#inherited-from_4","title":"Inherited from","text":"

CategoryColumnRegistration.sortCallback

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#titleprops","title":"titleProps","text":"

\u2022 titleProps: TitleCellProps

This function will be used to generate the columns title cell.

"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#inherited-from_5","title":"Inherited from","text":"

CategoryColumnRegistration.titleProps

"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/","title":"Renderer.Component.BadgeProps","text":"

@k8slens/extensions / Exports / Renderer / Component / BadgeProps

"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#interface-badgeprops","title":"Interface: BadgeProps","text":"

Renderer.Component.BadgeProps

"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#hierarchy","title":"Hierarchy","text":"
  • HTMLAttributes<HTMLDivElement>

\u21b3 BadgeProps

"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#properties","title":"Properties","text":"
  • disabled
  • expandable
  • flat
  • label
  • scrollable
  • small
"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#disabled","title":"disabled","text":"

\u2022 Optional disabled: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#expandable","title":"expandable","text":"

\u2022 Optional expandable: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#flat","title":"flat","text":"

\u2022 Optional flat: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#label","title":"label","text":"

\u2022 Optional label: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#scrollable","title":"scrollable","text":"

\u2022 Optional scrollable: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#small","title":"small","text":"

\u2022 Optional small: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/","title":"Renderer.Component.BarChartProps","text":"

@k8slens/extensions / Exports / Renderer / Component / BarChartProps

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#interface-barchartprops","title":"Interface: BarChartProps","text":"

Renderer.Component.BarChartProps

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#hierarchy","title":"Hierarchy","text":"
  • ChartProps

\u21b3 BarChartProps

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#properties","title":"Properties","text":"
  • className
  • data
  • data-testid
  • height
  • legendColors
  • legendPosition
  • name
  • options
  • plugins
  • redraw
  • showChart
  • showLegend
  • timeLabelStep
  • title
  • type
  • width
"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#inherited-from","title":"Inherited from","text":"

ChartProps.className

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#data","title":"data","text":"

\u2022 data: ChartData

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#inherited-from_1","title":"Inherited from","text":"

ChartProps.data

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#data-testid","title":"data-testid","text":"

\u2022 Optional data-testid: string

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#inherited-from_2","title":"Inherited from","text":"

ChartProps.data-testid

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#height","title":"height","text":"

\u2022 Optional height: string | number

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#inherited-from_3","title":"Inherited from","text":"

ChartProps.height

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#legendcolors","title":"legendColors","text":"

\u2022 Optional legendColors: string[]

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#inherited-from_4","title":"Inherited from","text":"

ChartProps.legendColors

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#legendposition","title":"legendPosition","text":"

\u2022 Optional legendPosition: \"bottom\"

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#inherited-from_5","title":"Inherited from","text":"

ChartProps.legendPosition

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#name","title":"name","text":"

\u2022 Optional name: string

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#options","title":"options","text":"

\u2022 Optional options: ChartOptions

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#inherited-from_6","title":"Inherited from","text":"

ChartProps.options

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#plugins","title":"plugins","text":"

\u2022 Optional plugins: PluginServiceRegistrationOptions[]

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#inherited-from_7","title":"Inherited from","text":"

ChartProps.plugins

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#redraw","title":"redraw","text":"

\u2022 Optional redraw: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#inherited-from_8","title":"Inherited from","text":"

ChartProps.redraw

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#showchart","title":"showChart","text":"

\u2022 Optional showChart: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#inherited-from_9","title":"Inherited from","text":"

ChartProps.showChart

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#showlegend","title":"showLegend","text":"

\u2022 Optional showLegend: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#inherited-from_10","title":"Inherited from","text":"

ChartProps.showLegend

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#timelabelstep","title":"timeLabelStep","text":"

\u2022 Optional timeLabelStep: number

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#title","title":"title","text":"

\u2022 Optional title: string

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#inherited-from_11","title":"Inherited from","text":"

ChartProps.title

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#type","title":"type","text":"

\u2022 Optional type: ChartKind

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#inherited-from_12","title":"Inherited from","text":"

ChartProps.type

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#width","title":"width","text":"

\u2022 Optional width: string | number

"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#inherited-from_13","title":"Inherited from","text":"

ChartProps.width

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/","title":"Renderer.Component.BaseIconProps","text":"

@k8slens/extensions / Exports / Renderer / Component / BaseIconProps

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#interface-baseiconprops","title":"Interface: BaseIconProps","text":"

Renderer.Component.BaseIconProps

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#hierarchy","title":"Hierarchy","text":"
  • BaseIconProps

\u21b3 IconProps

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#properties","title":"Properties","text":"
  • active
  • big
  • data-testid
  • disabled
  • focusable
  • href
  • interactive
  • link
  • material
  • size
  • small
  • smallest
  • sticker
  • svg
"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#active","title":"active","text":"

\u2022 Optional active: boolean

apply active-state styles

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#big","title":"big","text":"

\u2022 Optional big: boolean

A pre-defined icon-size

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#data-testid","title":"data-testid","text":"

\u2022 Optional data-testid: string

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#disabled","title":"disabled","text":"

\u2022 Optional disabled: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#focusable","title":"focusable","text":"

\u2022 Optional focusable: boolean

Allow focus to the icon to show .active styles. Only applicable if interactive is true.

Default

true\n
"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#href","title":"href","text":"

\u2022 Optional href: string

render icon as hyperlink

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#interactive","title":"interactive","text":"

\u2022 Optional interactive: boolean

indicates that icon is interactive and highlight it on focus/hover

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#link","title":"link","text":"

\u2022 Optional link: LocationDescriptor<unknown>

render icon as NavLink from react-router-dom

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#material","title":"material","text":"

\u2022 Optional material: string

One of the names from https://material.io/icons/

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#size","title":"size","text":"

\u2022 Optional size: string | number

The icon size (css units)

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#small","title":"small","text":"

\u2022 Optional small: boolean

A pre-defined icon-size

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#smallest","title":"smallest","text":"

\u2022 Optional smallest: boolean

A pre-defined icon-size

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#sticker","title":"sticker","text":"

\u2022 Optional sticker: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#svg","title":"svg","text":"

\u2022 Optional svg: string

Either an SVG XML or one of NamedSvg

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/","title":"Renderer.Component.ButtonProps","text":"

@k8slens/extensions / Exports / Renderer / Component / ButtonProps

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#interface-buttonprops","title":"Interface: ButtonProps","text":"

Renderer.Component.ButtonProps

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#hierarchy","title":"Hierarchy","text":"
  • ButtonHTMLAttributes<any>

\u21b3 ButtonProps

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#properties","title":"Properties","text":"
  • accent
  • active
  • big
  • hidden
  • href
  • label
  • light
  • outlined
  • plain
  • primary
  • round
  • target
  • waiting
"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#accent","title":"accent","text":"

\u2022 Optional accent: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#active","title":"active","text":"

\u2022 Optional active: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#big","title":"big","text":"

\u2022 Optional big: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#hidden","title":"hidden","text":"

\u2022 Optional hidden: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#overrides","title":"Overrides","text":"

ButtonHTMLAttributes.hidden

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#href","title":"href","text":"

\u2022 Optional href: string

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#label","title":"label","text":"

\u2022 Optional label: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#light","title":"light","text":"

\u2022 Optional light: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#outlined","title":"outlined","text":"

\u2022 Optional outlined: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#plain","title":"plain","text":"

\u2022 Optional plain: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#primary","title":"primary","text":"

\u2022 Optional primary: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#round","title":"round","text":"

\u2022 Optional round: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#target","title":"target","text":"

\u2022 Optional target: \"_blank\"

"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#waiting","title":"waiting","text":"

\u2022 Optional waiting: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/","title":"Renderer.Component.CheckboxProps","text":"

@k8slens/extensions / Exports / Renderer / Component / CheckboxProps

"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#interface-checkboxprops","title":"Interface: CheckboxProps","text":"

Renderer.Component.CheckboxProps

"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#properties","title":"Properties","text":"
  • children
  • className
  • disabled
  • inline
  • label
  • value
"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#methods","title":"Methods","text":"
  • onChange
"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#children","title":"children","text":"

\u2022 Optional children: SingleOrMany<ReactChild | ReactFragment>

"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#disabled","title":"disabled","text":"

\u2022 Optional disabled: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#inline","title":"inline","text":"

\u2022 Optional inline: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#label","title":"label","text":"

\u2022 Optional label: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#value","title":"value","text":"

\u2022 Optional value: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#onchange","title":"onChange","text":"

\u25b8 Optional onChange(value, evt): void

"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#parameters","title":"Parameters","text":"Name Type value boolean evt ChangeEvent<HTMLInputElement>"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/","title":"Renderer.Component.ConfirmDialogBooleanParams","text":"

@k8slens/extensions / Exports / Renderer / Component / ConfirmDialogBooleanParams

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#interface-confirmdialogbooleanparams","title":"Interface: ConfirmDialogBooleanParams","text":"

Renderer.Component.ConfirmDialogBooleanParams

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#hierarchy","title":"Hierarchy","text":"
  • ConfirmDialogBooleanParams

\u21b3 ConfirmDialogParams

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#properties","title":"Properties","text":"
  • cancelButtonProps
  • icon
  • labelCancel
  • labelOk
  • message
  • okButtonProps
"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#cancelbuttonprops","title":"cancelButtonProps","text":"

\u2022 Optional cancelButtonProps: Partial<ButtonProps>

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#icon","title":"icon","text":"

\u2022 Optional icon: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#labelcancel","title":"labelCancel","text":"

\u2022 Optional labelCancel: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#labelok","title":"labelOk","text":"

\u2022 Optional labelOk: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#message","title":"message","text":"

\u2022 message: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#okbuttonprops","title":"okButtonProps","text":"

\u2022 Optional okButtonProps: Partial<ButtonProps>

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/","title":"Renderer.Component.ConfirmDialogParams","text":"

@k8slens/extensions / Exports / Renderer / Component / ConfirmDialogParams

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#interface-confirmdialogparams","title":"Interface: ConfirmDialogParams","text":"

Renderer.Component.ConfirmDialogParams

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#hierarchy","title":"Hierarchy","text":"
  • ConfirmDialogBooleanParams

\u21b3 ConfirmDialogParams

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#properties","title":"Properties","text":"
  • cancel
  • cancelButtonProps
  • icon
  • labelCancel
  • labelOk
  • message
  • ok
  • okButtonProps
"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#cancel","title":"cancel","text":"

\u2022 Optional cancel: () => any

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#type-declaration","title":"Type declaration","text":"

\u25b8 (): any

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#returns","title":"Returns","text":"

any

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#cancelbuttonprops","title":"cancelButtonProps","text":"

\u2022 Optional cancelButtonProps: Partial<ButtonProps>

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#inherited-from","title":"Inherited from","text":"

ConfirmDialogBooleanParams.cancelButtonProps

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#icon","title":"icon","text":"

\u2022 Optional icon: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#inherited-from_1","title":"Inherited from","text":"

ConfirmDialogBooleanParams.icon

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#labelcancel","title":"labelCancel","text":"

\u2022 Optional labelCancel: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#inherited-from_2","title":"Inherited from","text":"

ConfirmDialogBooleanParams.labelCancel

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#labelok","title":"labelOk","text":"

\u2022 Optional labelOk: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#inherited-from_3","title":"Inherited from","text":"

ConfirmDialogBooleanParams.labelOk

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#message","title":"message","text":"

\u2022 message: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#inherited-from_4","title":"Inherited from","text":"

ConfirmDialogBooleanParams.message

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#ok","title":"ok","text":"

\u2022 Optional ok: () => any

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (): any

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#returns_1","title":"Returns","text":"

any

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#okbuttonprops","title":"okButtonProps","text":"

\u2022 Optional okButtonProps: Partial<ButtonProps>

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#inherited-from_5","title":"Inherited from","text":"

ConfirmDialogBooleanParams.okButtonProps

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/","title":"Renderer.Component.ConfirmDialogProps","text":"

@k8slens/extensions / Exports / Renderer / Component / ConfirmDialogProps

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#interface-confirmdialogprops","title":"Interface: ConfirmDialogProps","text":"

Renderer.Component.ConfirmDialogProps

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#hierarchy","title":"Hierarchy","text":"
  • Partial<DialogProps>

\u21b3 ConfirmDialogProps

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#properties","title":"Properties","text":"
  • animated
  • children
  • className
  • close
  • data-testid
  • isOpen
  • modal
  • onClose
  • onOpen
  • open
  • pinned
"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#animated","title":"animated","text":"

\u2022 Optional animated: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#inherited-from","title":"Inherited from","text":"

Partial.animated

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#children","title":"children","text":"

\u2022 Optional children: ReactNode | ReactNode[]

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#inherited-from_1","title":"Inherited from","text":"

Partial.children

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#inherited-from_2","title":"Inherited from","text":"

Partial.className

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#close","title":"close","text":"

\u2022 Optional close: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#type-declaration","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#inherited-from_3","title":"Inherited from","text":"

Partial.close

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#data-testid","title":"data-testid","text":"

\u2022 Optional data-testid: string

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#inherited-from_4","title":"Inherited from","text":"

Partial.data-testid

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#isopen","title":"isOpen","text":"

\u2022 Optional isOpen: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#inherited-from_5","title":"Inherited from","text":"

Partial.isOpen

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#modal","title":"modal","text":"

\u2022 Optional modal: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#inherited-from_6","title":"Inherited from","text":"

Partial.modal

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#onclose","title":"onClose","text":"

\u2022 Optional onClose: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#inherited-from_7","title":"Inherited from","text":"

Partial.onClose

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#onopen","title":"onOpen","text":"

\u2022 Optional onOpen: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#inherited-from_8","title":"Inherited from","text":"

Partial.onOpen

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#open","title":"open","text":"

\u2022 Optional open: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#inherited-from_9","title":"Inherited from","text":"

Partial.open

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#pinned","title":"pinned","text":"

\u2022 Optional pinned: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#inherited-from_10","title":"Inherited from","text":"

Partial.pinned

"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/","title":"Renderer.Component.CreateNotificationOptions","text":"

@k8slens/extensions / Exports / Renderer / Component / CreateNotificationOptions

"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#interface-createnotificationoptions","title":"Interface: CreateNotificationOptions","text":"

Renderer.Component.CreateNotificationOptions

"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#properties","title":"Properties","text":"
  • id
  • timeout
"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#methods","title":"Methods","text":"
  • onClose
"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#id","title":"id","text":"

\u2022 Optional id: NotificationId

"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#timeout","title":"timeout","text":"

\u2022 Optional timeout: number

"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#onclose","title":"onClose","text":"

\u25b8 Optional onClose(): void

"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.CustomPlaceholderProps/","title":"Renderer.Component.CustomPlaceholderProps","text":"

@k8slens/extensions / Exports / Renderer / Component / CustomPlaceholderProps

"},{"location":"extensions/api/interfaces/Renderer.Component.CustomPlaceholderProps/#interface-customplaceholderprops","title":"Interface: CustomPlaceholderProps","text":"

Renderer.Component.CustomPlaceholderProps

"},{"location":"extensions/api/interfaces/Renderer.Component.CustomPlaceholderProps/#hierarchy","title":"Hierarchy","text":"
  • PlaceholderProps<NamespaceSelectFilterOption, true>

\u21b3 CustomPlaceholderProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/","title":"Renderer.Component.DialogProps","text":"

@k8slens/extensions / Exports / Renderer / Component / DialogProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#interface-dialogprops","title":"Interface: DialogProps","text":"

Renderer.Component.DialogProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#properties","title":"Properties","text":"
  • animated
  • children
  • className
  • close
  • data-testid
  • isOpen
  • modal
  • onClose
  • onOpen
  • open
  • pinned
"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#animated","title":"animated","text":"

\u2022 Optional animated: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#children","title":"children","text":"

\u2022 Optional children: ReactNode | ReactNode[]

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#close","title":"close","text":"

\u2022 Optional close: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#type-declaration","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#data-testid","title":"data-testid","text":"

\u2022 Optional data-testid: string

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#isopen","title":"isOpen","text":"

\u2022 Optional isOpen: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#modal","title":"modal","text":"

\u2022 Optional modal: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#onclose","title":"onClose","text":"

\u2022 Optional onClose: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#onopen","title":"onOpen","text":"

\u2022 Optional onOpen: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#open","title":"open","text":"

\u2022 Optional open: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#pinned","title":"pinned","text":"

\u2022 Optional pinned: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/","title":"Renderer.Component.DrawerItemLabelsProps","text":"

@k8slens/extensions / Exports / Renderer / Component / DrawerItemLabelsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#interface-draweritemlabelsprops","title":"Interface: DrawerItemLabelsProps","text":"

Renderer.Component.DrawerItemLabelsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#hierarchy","title":"Hierarchy","text":"
  • DrawerItemProps

\u21b3 DrawerItemLabelsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#properties","title":"Properties","text":"
  • hidden
  • labels
  • labelsOnly
  • name
  • renderBooleans
  • title
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#hidden","title":"hidden","text":"

\u2022 Optional hidden: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#inherited-from","title":"Inherited from","text":"

DrawerItemProps.hidden

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#labels","title":"labels","text":"

\u2022 labels: string[] | Partial<Record<string, string>>

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#labelsonly","title":"labelsOnly","text":"

\u2022 Optional labelsOnly: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#inherited-from_1","title":"Inherited from","text":"

DrawerItemProps.labelsOnly

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#name","title":"name","text":"

\u2022 name: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#inherited-from_2","title":"Inherited from","text":"

DrawerItemProps.name

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#renderbooleans","title":"renderBooleans","text":"

\u2022 Optional renderBooleans: boolean

Deprecated

This prop is no longer used, you should stringify the booleans yourself.

This was only meant to be an internal prop anyway.

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#inherited-from_3","title":"Inherited from","text":"

DrawerItemProps.renderBooleans

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#title","title":"title","text":"

\u2022 Optional title: string

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#inherited-from_4","title":"Inherited from","text":"

DrawerItemProps.title

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/","title":"Renderer.Component.DrawerItemProps","text":"

@k8slens/extensions / Exports / Renderer / Component / DrawerItemProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#interface-draweritemprops","title":"Interface: DrawerItemProps","text":"

Renderer.Component.DrawerItemProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#hierarchy","title":"Hierarchy","text":"
  • HTMLAttributes<HTMLDivElement>

\u21b3 DrawerItemProps

\u21b3\u21b3 DrawerItemLabelsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#properties","title":"Properties","text":"
  • hidden
  • labelsOnly
  • name
  • renderBooleans
  • title
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#hidden","title":"hidden","text":"

\u2022 Optional hidden: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#overrides","title":"Overrides","text":"

React.HTMLAttributes.hidden

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#labelsonly","title":"labelsOnly","text":"

\u2022 Optional labelsOnly: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#name","title":"name","text":"

\u2022 name: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#renderbooleans","title":"renderBooleans","text":"

\u2022 Optional renderBooleans: boolean

Deprecated

This prop is no longer used, you should stringify the booleans yourself.

This was only meant to be an internal prop anyway.

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#title","title":"title","text":"

\u2022 Optional title: string

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#overrides_1","title":"Overrides","text":"

React.HTMLAttributes.title

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/","title":"Renderer.Component.DrawerParamTogglerProps","text":"

@k8slens/extensions / Exports / Renderer / Component / DrawerParamTogglerProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/#interface-drawerparamtogglerprops","title":"Interface: DrawerParamTogglerProps","text":"

Renderer.Component.DrawerParamTogglerProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/#properties","title":"Properties","text":"
  • children
  • label
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/#children","title":"children","text":"

\u2022 children: ReactNode | ReactNode[]

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/#label","title":"label","text":"

\u2022 label: string | number

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/","title":"Renderer.Component.DrawerProps","text":"

@k8slens/extensions / Exports / Renderer / Component / DrawerProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#interface-drawerprops","title":"Interface: DrawerProps","text":"

Renderer.Component.DrawerProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#properties","title":"Properties","text":"
  • animation
  • children
  • className
  • contentClass
  • data-testid
  • onClose
  • open
  • position
  • size
  • testIdForClose
  • title
  • toolbar
  • usePortal
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#animation","title":"animation","text":"

\u2022 Optional animation: string

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#children","title":"children","text":"

\u2022 Optional children: SingleOrMany<ReactNode>

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#classname","title":"className","text":"

\u2022 Optional className: string | object

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#contentclass","title":"contentClass","text":"

\u2022 Optional contentClass: string | object

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#data-testid","title":"data-testid","text":"

\u2022 Optional data-testid: string

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#onclose","title":"onClose","text":"

\u2022 Optional onClose: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#type-declaration","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#open","title":"open","text":"

\u2022 open: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#position","title":"position","text":"

\u2022 Optional position: DrawerPosition

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#size","title":"size","text":"

\u2022 Optional size: string

The width or heigh (depending on position) of the Drawer.

If not set then the Drawer will be resizable.

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#testidforclose","title":"testIdForClose","text":"

\u2022 Optional testIdForClose: string

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#title","title":"title","text":"

\u2022 title: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#toolbar","title":"toolbar","text":"

\u2022 Optional toolbar: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#useportal","title":"usePortal","text":"

\u2022 Optional usePortal: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/","title":"Renderer.Component.DrawerTitleProps","text":"

@k8slens/extensions / Exports / Renderer / Component / DrawerTitleProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#interface-drawertitleprops","title":"Interface: DrawerTitleProps","text":"

Renderer.Component.DrawerTitleProps

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#properties","title":"Properties","text":"
  • children
  • className
  • size
  • title
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#children","title":"children","text":"

\u2022 Optional children: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#size","title":"size","text":"

\u2022 Optional size: \"title\" | \"sub-title\"

Specifies how large this title is

Default

\"title\"\n
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#title","title":"title","text":"

\u2022 Optional title: ReactNode

Deprecated

Prefer passing the value as children

"},{"location":"extensions/api/interfaces/Renderer.Component.IconDataFnArg/","title":"Renderer.Component.IconDataFnArg","text":"

@k8slens/extensions / Exports / Renderer / Component / IconDataFnArg

"},{"location":"extensions/api/interfaces/Renderer.Component.IconDataFnArg/#interface-icondatafnarg","title":"Interface: IconDataFnArg","text":"

Renderer.Component.IconDataFnArg

"},{"location":"extensions/api/interfaces/Renderer.Component.IconDataFnArg/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.IconDataFnArg/#properties","title":"Properties","text":"
  • isDirty
"},{"location":"extensions/api/interfaces/Renderer.Component.IconDataFnArg/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.IconDataFnArg/#isdirty","title":"isDirty","text":"

\u2022 isDirty: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/","title":"Renderer.Component.IconProps","text":"

@k8slens/extensions / Exports / Renderer / Component / IconProps

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#interface-iconprops","title":"Interface: IconProps","text":"

Renderer.Component.IconProps

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#hierarchy","title":"Hierarchy","text":"
  • HTMLAttributes<any>

  • BaseIconProps

\u21b3 IconProps

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#properties","title":"Properties","text":"
  • active
  • big
  • data-testid
  • disabled
  • focusable
  • href
  • interactive
  • link
  • material
  • size
  • small
  • smallest
  • sticker
  • svg
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#active","title":"active","text":"

\u2022 Optional active: boolean

apply active-state styles

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from","title":"Inherited from","text":"

BaseIconProps.active

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#big","title":"big","text":"

\u2022 Optional big: boolean

A pre-defined icon-size

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_1","title":"Inherited from","text":"

BaseIconProps.big

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#data-testid","title":"data-testid","text":"

\u2022 Optional data-testid: string

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_2","title":"Inherited from","text":"

BaseIconProps.data-testid

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#disabled","title":"disabled","text":"

\u2022 Optional disabled: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_3","title":"Inherited from","text":"

BaseIconProps.disabled

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#focusable","title":"focusable","text":"

\u2022 Optional focusable: boolean

Allow focus to the icon to show .active styles. Only applicable if interactive is true.

Default

true\n
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_4","title":"Inherited from","text":"

BaseIconProps.focusable

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#href","title":"href","text":"

\u2022 Optional href: string

render icon as hyperlink

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_5","title":"Inherited from","text":"

BaseIconProps.href

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#interactive","title":"interactive","text":"

\u2022 Optional interactive: boolean

indicates that icon is interactive and highlight it on focus/hover

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_6","title":"Inherited from","text":"

BaseIconProps.interactive

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#link","title":"link","text":"

\u2022 Optional link: LocationDescriptor<unknown>

render icon as NavLink from react-router-dom

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_7","title":"Inherited from","text":"

BaseIconProps.link

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#material","title":"material","text":"

\u2022 Optional material: string

One of the names from https://material.io/icons/

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_8","title":"Inherited from","text":"

BaseIconProps.material

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#size","title":"size","text":"

\u2022 Optional size: string | number

The icon size (css units)

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_9","title":"Inherited from","text":"

BaseIconProps.size

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#small","title":"small","text":"

\u2022 Optional small: boolean

A pre-defined icon-size

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_10","title":"Inherited from","text":"

BaseIconProps.small

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#smallest","title":"smallest","text":"

\u2022 Optional smallest: boolean

A pre-defined icon-size

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_11","title":"Inherited from","text":"

BaseIconProps.smallest

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#sticker","title":"sticker","text":"

\u2022 Optional sticker: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_12","title":"Inherited from","text":"

BaseIconProps.sticker

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#svg","title":"svg","text":"

\u2022 Optional svg: string

Either an SVG XML or one of NamedSvg

"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_13","title":"Inherited from","text":"

BaseIconProps.svg

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/","title":"Renderer.Component.KubeEventDetailsProps","text":"

@k8slens/extensions / Exports / Renderer / Component / KubeEventDetailsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/#interface-kubeeventdetailsprops","title":"Interface: KubeEventDetailsProps","text":"

Renderer.Component.KubeEventDetailsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/#properties","title":"Properties","text":"
  • object
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/#object","title":"object","text":"

\u2022 object: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/","title":"Renderer.Component.KubeObjectDetailsProps","text":"

@k8slens/extensions / Exports / Renderer / Component / KubeObjectDetailsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#interface-kubeobjectdetailspropskube","title":"Interface: KubeObjectDetailsProps<Kube>","text":"

Renderer.Component.KubeObjectDetailsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#type-parameters","title":"Type parameters","text":"Name Type Kube extends KubeObject = KubeObject"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#properties","title":"Properties","text":"
  • className
  • object
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#object","title":"object","text":"

\u2022 object: Kube

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/","title":"Renderer.Component.KubeObjectListLayoutProps","text":"

@k8slens/extensions / Exports / Renderer / Component / KubeObjectListLayoutProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#interface-kubeobjectlistlayoutpropsk-a-d","title":"Interface: KubeObjectListLayoutProps<K, A, D>","text":"

Renderer.Component.KubeObjectListLayoutProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#type-parameters","title":"Type parameters","text":"Name Type K extends KubeObject A extends KubeApi<K, D> D extends KubeJsonApiDataFor<K>"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#hierarchy","title":"Hierarchy","text":"
  • Omit<ItemListLayoutProps<K, false>, \"getItems\" | \"dependentStores\" | \"preloadStores\">

\u21b3 KubeObjectListLayoutProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#properties","title":"Properties","text":"
  • addRemoveButtons
  • className
  • columns
  • copyClassNameFromHeadCells
  • customizeHeader
  • customizeRemoveDialog
  • customizeTableRowProps
  • data-testid
  • dependentStores
  • detailsItem
  • failedToLoadMessage
  • filterCallbacks
  • filterItems
  • getItems
  • hasDetailsView
  • headerClassName
  • hideFilters
  • isConfigurable
  • isReady
  • isSelectable
  • items
  • onDetails
  • renderFooter
  • renderHeaderTitle
  • renderItemMenu
  • renderTableContents
  • renderTableHeader
  • resourceName
  • searchFilters
  • showHeader
  • sortingCallbacks
  • spinnerTestId
  • store
  • subscribeStores
  • tableId
  • tableProps
  • virtual
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#addremovebuttons","title":"addRemoveButtons","text":"

\u2022 Optional addRemoveButtons: Partial<AddRemoveButtonsProps>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from","title":"Inherited from","text":"

Omit.addRemoveButtons

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#classname","title":"className","text":"

\u2022 className: IClassName

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_1","title":"Inherited from","text":"

Omit.className

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#columns","title":"columns","text":"

\u2022 Optional columns: SpecificKubeListLayoutColumn<K>[]

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#copyclassnamefromheadcells","title":"copyClassNameFromHeadCells","text":"

\u2022 Optional copyClassNameFromHeadCells: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_2","title":"Inherited from","text":"

Omit.copyClassNameFromHeadCells

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#customizeheader","title":"customizeHeader","text":"

\u2022 Optional customizeHeader: HeaderCustomizer | HeaderCustomizer[]

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_3","title":"Inherited from","text":"

Omit.customizeHeader

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#customizeremovedialog","title":"customizeRemoveDialog","text":"

\u2022 Optional customizeRemoveDialog: (selectedItems: K[]) => Partial<ConfirmDialogParams>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#type-declaration","title":"Type declaration","text":"

\u25b8 (selectedItems): Partial<ConfirmDialogParams>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#parameters","title":"Parameters","text":"Name Type selectedItems K[]"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#returns","title":"Returns","text":"

Partial<ConfirmDialogParams>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_4","title":"Inherited from","text":"

Omit.customizeRemoveDialog

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#customizetablerowprops","title":"customizeTableRowProps","text":"

\u2022 Optional customizeTableRowProps: (item: K) => Partial<TableRowProps<K>>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (item): Partial<TableRowProps<K>>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#parameters_1","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#returns_1","title":"Returns","text":"

Partial<TableRowProps<K>>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_5","title":"Inherited from","text":"

Omit.customizeTableRowProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#data-testid","title":"data-testid","text":"

\u2022 Optional data-testid: string

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_6","title":"Inherited from","text":"

Omit.data-testid

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#dependentstores","title":"dependentStores","text":"

\u2022 Optional dependentStores: SubscribableStore[]

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#detailsitem","title":"detailsItem","text":"

\u2022 Optional detailsItem: K

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_7","title":"Inherited from","text":"

Omit.detailsItem

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#failedtoloadmessage","title":"failedToLoadMessage","text":"

\u2022 Optional failedToLoadMessage: ReactNode

Message to display when a store failed to load

Default

\"Failed to load items\"\n
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_8","title":"Inherited from","text":"

Omit.failedToLoadMessage

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#filtercallbacks","title":"filterCallbacks","text":"

\u2022 Optional filterCallbacks: ItemsFilters<K>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_9","title":"Inherited from","text":"

Omit.filterCallbacks

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#filteritems","title":"filterItems","text":"

\u2022 Optional filterItems: ItemsFilter<K>[]

Deprecated

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_10","title":"Inherited from","text":"

Omit.filterItems

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#getitems","title":"getItems","text":"

\u2022 Optional getItems: () => K[]

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (): K[]

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#returns_2","title":"Returns","text":"

K[]

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#hasdetailsview","title":"hasDetailsView","text":"

\u2022 Optional hasDetailsView: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_11","title":"Inherited from","text":"

Omit.hasDetailsView

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#headerclassname","title":"headerClassName","text":"

\u2022 Optional headerClassName: IClassName

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_12","title":"Inherited from","text":"

Omit.headerClassName

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#hidefilters","title":"hideFilters","text":"

\u2022 Optional hideFilters: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_13","title":"Inherited from","text":"

Omit.hideFilters

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#isconfigurable","title":"isConfigurable","text":"

\u2022 Optional isConfigurable: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_14","title":"Inherited from","text":"

Omit.isConfigurable

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#isready","title":"isReady","text":"

\u2022 Optional isReady: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_15","title":"Inherited from","text":"

Omit.isReady

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#isselectable","title":"isSelectable","text":"

\u2022 Optional isSelectable: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_16","title":"Inherited from","text":"

Omit.isSelectable

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#items","title":"items","text":"

\u2022 Optional items: K[]

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#ondetails","title":"onDetails","text":"

\u2022 Optional onDetails: (item: K) => void

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (item): void

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#parameters_2","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_17","title":"Inherited from","text":"

Omit.onDetails

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#renderfooter","title":"renderFooter","text":"

\u2022 Optional renderFooter: (parent: NonInjectedItemListLayout<K, false>) => ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (parent): ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#parameters_3","title":"Parameters","text":"Name Type parent NonInjectedItemListLayout<K, false>"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#returns_4","title":"Returns","text":"

ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_18","title":"Inherited from","text":"

Omit.renderFooter

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#renderheadertitle","title":"renderHeaderTitle","text":"

\u2022 Optional renderHeaderTitle: RenderHeaderTitle<K, false>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_19","title":"Inherited from","text":"

Omit.renderHeaderTitle

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#renderitemmenu","title":"renderItemMenu","text":"

\u2022 Optional renderItemMenu: (item: K, store: ItemListStore<K, false>) => ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (item, store): ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#parameters_4","title":"Parameters","text":"Name Type item K store ItemListStore<K, false>"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#returns_5","title":"Returns","text":"

ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_20","title":"Inherited from","text":"

Omit.renderItemMenu

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#rendertablecontents","title":"renderTableContents","text":"

\u2022 renderTableContents: (item: K) => (ReactNode | TableCellProps)[]

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (item): (ReactNode | TableCellProps)[]

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#parameters_5","title":"Parameters","text":"Name Type item K"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#returns_6","title":"Returns","text":"

(ReactNode | TableCellProps)[]

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_21","title":"Inherited from","text":"

Omit.renderTableContents

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#rendertableheader","title":"renderTableHeader","text":"

\u2022 Optional renderTableHeader: (undefined | null | TableCellProps)[]

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_22","title":"Inherited from","text":"

Omit.renderTableHeader

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#resourcename","title":"resourceName","text":"

\u2022 Optional resourceName: string

Customize resource name for e.g. search input (\"Search ...\"\") If not provided, ResourceNames is used instead with a fallback to resource kind."},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#searchfilters","title":"searchFilters","text":"

\u2022 Optional searchFilters: SearchFilter<K>[]

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_23","title":"Inherited from","text":"

Omit.searchFilters

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#showheader","title":"showHeader","text":"

\u2022 Optional showHeader: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_24","title":"Inherited from","text":"

Omit.showHeader

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#sortingcallbacks","title":"sortingCallbacks","text":"

\u2022 Optional sortingCallbacks: TableSortCallbacks<K>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_25","title":"Inherited from","text":"

Omit.sortingCallbacks

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#spinnertestid","title":"spinnerTestId","text":"

\u2022 Optional spinnerTestId: string

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_26","title":"Inherited from","text":"

Omit.spinnerTestId

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#store","title":"store","text":"

\u2022 store: KubeItemListStore<K>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#overrides","title":"Overrides","text":"

Omit.store

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#subscribestores","title":"subscribeStores","text":"

\u2022 Optional subscribeStores: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#tableid","title":"tableId","text":"

\u2022 Optional tableId: string

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_27","title":"Inherited from","text":"

Omit.tableId

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#tableprops","title":"tableProps","text":"

\u2022 Optional tableProps: Partial<TableProps<K>>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_28","title":"Inherited from","text":"

Omit.tableProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#virtual","title":"virtual","text":"

\u2022 Optional virtual: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_29","title":"Inherited from","text":"

Omit.virtual

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/","title":"Renderer.Component.KubeObjectMenuProps","text":"

@k8slens/extensions / Exports / Renderer / Component / KubeObjectMenuProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#interface-kubeobjectmenupropstkubeobject","title":"Interface: KubeObjectMenuProps<TKubeObject>","text":"

Renderer.Component.KubeObjectMenuProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#type-parameters","title":"Type parameters","text":"Name Type TKubeObject extends KubeObject"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#hierarchy","title":"Hierarchy","text":"
  • MenuActionsProps

\u21b3 KubeObjectMenuProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#properties","title":"Properties","text":"
  • animated
  • autoCloseOnSelect
  • autoFocus
  • children
  • className
  • closeOnClickItem
  • closeOnClickOutside
  • closeOnScroll
  • data-testid
  • editable
  • htmlFor
  • id
  • isOpen
  • object
  • onOpen
  • position
  • removable
  • removeAction
  • removeConfirmationMessage
  • toggleEvent
  • toolbar
  • triggerIcon
  • updateAction
  • usePortal
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#methods","title":"Methods","text":"
  • close
  • open
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#animated","title":"animated","text":"

\u2022 Optional animated: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from","title":"Inherited from","text":"

MenuActionsProps.animated

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#autocloseonselect","title":"autoCloseOnSelect","text":"

\u2022 Optional autoCloseOnSelect: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_1","title":"Inherited from","text":"

MenuActionsProps.autoCloseOnSelect

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#autofocus","title":"autoFocus","text":"

\u2022 Optional autoFocus: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_2","title":"Inherited from","text":"

MenuActionsProps.autoFocus

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#children","title":"children","text":"

\u2022 Optional children: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_3","title":"Inherited from","text":"

MenuActionsProps.children

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_4","title":"Inherited from","text":"

MenuActionsProps.className

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#closeonclickitem","title":"closeOnClickItem","text":"

\u2022 Optional closeOnClickItem: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_5","title":"Inherited from","text":"

MenuActionsProps.closeOnClickItem

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#closeonclickoutside","title":"closeOnClickOutside","text":"

\u2022 Optional closeOnClickOutside: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_6","title":"Inherited from","text":"

MenuActionsProps.closeOnClickOutside

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#closeonscroll","title":"closeOnScroll","text":"

\u2022 Optional closeOnScroll: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_7","title":"Inherited from","text":"

MenuActionsProps.closeOnScroll

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#data-testid","title":"data-testid","text":"

\u2022 Optional data-testid: string

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_8","title":"Inherited from","text":"

MenuActionsProps.data-testid

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#editable","title":"editable","text":"

\u2022 Optional editable: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#htmlfor","title":"htmlFor","text":"

\u2022 Optional htmlFor: string

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_9","title":"Inherited from","text":"

MenuActionsProps.htmlFor

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#id","title":"id","text":"

\u2022 Optional id: string

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_10","title":"Inherited from","text":"

MenuActionsProps.id

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#isopen","title":"isOpen","text":"

\u2022 Optional isOpen: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_11","title":"Inherited from","text":"

MenuActionsProps.isOpen

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#object","title":"object","text":"

\u2022 object: TKubeObject

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#onopen","title":"onOpen","text":"

\u2022 Optional onOpen: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#type-declaration","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_12","title":"Inherited from","text":"

MenuActionsProps.onOpen

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#position","title":"position","text":"

\u2022 Optional position: MenuPosition

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_13","title":"Inherited from","text":"

MenuActionsProps.position

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#removable","title":"removable","text":"

\u2022 Optional removable: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#removeaction","title":"removeAction","text":"

\u2022 Optional removeAction: () => void | Promise<void>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (): void | Promise<void>

Deprecated

Provide your own remove <MenuItem> as part of the children passed to this component

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#returns_1","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_14","title":"Inherited from","text":"

MenuActionsProps.removeAction

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#removeconfirmationmessage","title":"removeConfirmationMessage","text":"

\u2022 Optional removeConfirmationMessage: ReactNode | () => ReactNode

Deprecated

Provide your own remove <MenuItem> as part of the children passed to this component

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_15","title":"Inherited from","text":"

MenuActionsProps.removeConfirmationMessage

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#toggleevent","title":"toggleEvent","text":"

\u2022 Optional toggleEvent: \"click\" | \"contextmenu\"

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_16","title":"Inherited from","text":"

MenuActionsProps.toggleEvent

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#toolbar","title":"toolbar","text":"

\u2022 Optional toolbar: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_17","title":"Inherited from","text":"

MenuActionsProps.toolbar

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#triggericon","title":"triggerIcon","text":"

\u2022 Optional triggerIcon: ReactNode | IconProps & TooltipDecoratorProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_18","title":"Inherited from","text":"

MenuActionsProps.triggerIcon

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#updateaction","title":"updateAction","text":"

\u2022 Optional updateAction: () => void | Promise<void>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (): void | Promise<void>

Deprecated

Provide your own update <MenuItem> as part of the children passed to this component

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#returns_2","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_19","title":"Inherited from","text":"

MenuActionsProps.updateAction

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#useportal","title":"usePortal","text":"

\u2022 Optional usePortal: boolean | HTMLElement

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_20","title":"Inherited from","text":"

MenuActionsProps.usePortal

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#close","title":"close","text":"

\u25b8 Optional close(): void

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_21","title":"Inherited from","text":"

MenuActionsProps.close

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#open","title":"open","text":"

\u25b8 Optional open(): void

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#returns_4","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#inherited-from_22","title":"Inherited from","text":"

MenuActionsProps.open

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/","title":"Renderer.Component.KubeObjectMetaProps","text":"

@k8slens/extensions / Exports / Renderer / Component / KubeObjectMetaProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/#interface-kubeobjectmetaprops","title":"Interface: KubeObjectMetaProps","text":"

Renderer.Component.KubeObjectMetaProps

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/#properties","title":"Properties","text":"
  • hideFields
  • object
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/#hidefields","title":"hideFields","text":"

\u2022 Optional hideFields: keyof BaseKubeJsonApiObjectMetadata<KubeObjectScope>[]

"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/#object","title":"object","text":"

\u2022 object: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/","title":"Renderer.Component.LineProgressProps","text":"

@k8slens/extensions / Exports / Renderer / Component / LineProgressProps

"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#interface-lineprogressprops","title":"Interface: LineProgressProps","text":"

Renderer.Component.LineProgressProps

"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#hierarchy","title":"Hierarchy","text":"
  • HTMLProps<HTMLDivElement>

\u21b3 LineProgressProps

"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#properties","title":"Properties","text":"
  • className
  • max
  • min
  • precise
  • value
"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#classname","title":"className","text":"

\u2022 Optional className: any

"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#overrides","title":"Overrides","text":"

React.HTMLProps.className

"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#max","title":"max","text":"

\u2022 Optional max: number

"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#overrides_1","title":"Overrides","text":"

React.HTMLProps.max

"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#min","title":"min","text":"

\u2022 Optional min: number

"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#overrides_2","title":"Overrides","text":"

React.HTMLProps.min

"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#precise","title":"precise","text":"

\u2022 Optional precise: number

"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#value","title":"value","text":"

\u2022 value: number

"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#overrides_3","title":"Overrides","text":"

React.HTMLProps.value

"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/","title":"Renderer.Component.MainLayoutProps","text":"

@k8slens/extensions / Exports / Renderer / Component / MainLayoutProps

"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#interface-mainlayoutprops","title":"Interface: MainLayoutProps","text":"

Renderer.Component.MainLayoutProps

"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#properties","title":"Properties","text":"
  • children
  • className
  • footer
  • sidebar
"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#children","title":"children","text":"

\u2022 Optional children: ReactNode | ReactNode[]

"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#footer","title":"footer","text":"

\u2022 Optional footer: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#sidebar","title":"sidebar","text":"

\u2022 sidebar: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/","title":"Renderer.Component.MenuActionsProps","text":"

@k8slens/extensions / Exports / Renderer / Component / MenuActionsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#interface-menuactionsprops","title":"Interface: MenuActionsProps","text":"

Renderer.Component.MenuActionsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#hierarchy","title":"Hierarchy","text":"
  • Partial<MenuProps>

\u21b3 MenuActionsProps

\u21b3\u21b3 KubeObjectMenuProps

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#properties","title":"Properties","text":"
  • animated
  • autoCloseOnSelect
  • autoFocus
  • children
  • className
  • closeOnClickItem
  • closeOnClickOutside
  • closeOnScroll
  • data-testid
  • htmlFor
  • id
  • isOpen
  • onOpen
  • position
  • removeAction
  • removeConfirmationMessage
  • toggleEvent
  • toolbar
  • triggerIcon
  • updateAction
  • usePortal
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#methods","title":"Methods","text":"
  • close
  • open
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#animated","title":"animated","text":"

\u2022 Optional animated: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#inherited-from","title":"Inherited from","text":"

Partial.animated

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#autocloseonselect","title":"autoCloseOnSelect","text":"

\u2022 Optional autoCloseOnSelect: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#autofocus","title":"autoFocus","text":"

\u2022 Optional autoFocus: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#inherited-from_1","title":"Inherited from","text":"

Partial.autoFocus

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#children","title":"children","text":"

\u2022 Optional children: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#inherited-from_2","title":"Inherited from","text":"

Partial.children

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#overrides","title":"Overrides","text":"

Partial.className

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#closeonclickitem","title":"closeOnClickItem","text":"

\u2022 Optional closeOnClickItem: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#inherited-from_3","title":"Inherited from","text":"

Partial.closeOnClickItem

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#closeonclickoutside","title":"closeOnClickOutside","text":"

\u2022 Optional closeOnClickOutside: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#inherited-from_4","title":"Inherited from","text":"

Partial.closeOnClickOutside

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#closeonscroll","title":"closeOnScroll","text":"

\u2022 Optional closeOnScroll: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#inherited-from_5","title":"Inherited from","text":"

Partial.closeOnScroll

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#data-testid","title":"data-testid","text":"

\u2022 Optional data-testid: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#inherited-from_6","title":"Inherited from","text":"

Partial.data-testid

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#htmlfor","title":"htmlFor","text":"

\u2022 Optional htmlFor: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#inherited-from_7","title":"Inherited from","text":"

Partial.htmlFor

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#id","title":"id","text":"

\u2022 Optional id: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#overrides_1","title":"Overrides","text":"

Partial.id

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#isopen","title":"isOpen","text":"

\u2022 Optional isOpen: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#inherited-from_8","title":"Inherited from","text":"

Partial.isOpen

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#onopen","title":"onOpen","text":"

\u2022 Optional onOpen: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#type-declaration","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#position","title":"position","text":"

\u2022 Optional position: MenuPosition

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#inherited-from_9","title":"Inherited from","text":"

Partial.position

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#removeaction","title":"removeAction","text":"

\u2022 Optional removeAction: () => void | Promise<void>

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (): void | Promise<void>

Deprecated

Provide your own remove <MenuItem> as part of the children passed to this component

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#returns_1","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#removeconfirmationmessage","title":"removeConfirmationMessage","text":"

\u2022 Optional removeConfirmationMessage: ReactNode | () => ReactNode

Deprecated

Provide your own remove <MenuItem> as part of the children passed to this component

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#toggleevent","title":"toggleEvent","text":"

\u2022 Optional toggleEvent: \"click\" | \"contextmenu\"

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#inherited-from_10","title":"Inherited from","text":"

Partial.toggleEvent

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#toolbar","title":"toolbar","text":"

\u2022 Optional toolbar: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#triggericon","title":"triggerIcon","text":"

\u2022 Optional triggerIcon: ReactNode | IconProps & TooltipDecoratorProps

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#updateaction","title":"updateAction","text":"

\u2022 Optional updateAction: () => void | Promise<void>

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (): void | Promise<void>

Deprecated

Provide your own update <MenuItem> as part of the children passed to this component

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#returns_2","title":"Returns","text":"

void | Promise<void>

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#useportal","title":"usePortal","text":"

\u2022 Optional usePortal: boolean | HTMLElement

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#inherited-from_11","title":"Inherited from","text":"

Partial.usePortal

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#close","title":"close","text":"

\u25b8 Optional close(): void

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#inherited-from_12","title":"Inherited from","text":"

Partial.close

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#open","title":"open","text":"

\u25b8 Optional open(): void

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#returns_4","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#inherited-from_13","title":"Inherited from","text":"

Partial.open

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/","title":"Renderer.Component.MenuContextValue","text":"

@k8slens/extensions / Exports / Renderer / Component / MenuContextValue

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#interface-menucontextvalue","title":"Interface: MenuContextValue","text":"

Renderer.Component.MenuContextValue

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#properties","title":"Properties","text":"
  • close
  • props
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#close","title":"close","text":"

\u2022 close: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#type-declaration","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#props","title":"props","text":"

\u2022 Readonly props: Readonly<MenuProps>

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/","title":"Renderer.Component.MenuItemProps","text":"

@k8slens/extensions / Exports / Renderer / Component / MenuItemProps

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#interface-menuitemprops","title":"Interface: MenuItemProps","text":"

Renderer.Component.MenuItemProps

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#hierarchy","title":"Hierarchy","text":"
  • HTMLProps<any>

\u21b3 MenuItemProps

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#properties","title":"Properties","text":"
  • active
  • disabled
  • href
  • icon
  • spacer
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#active","title":"active","text":"

\u2022 Optional active: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#disabled","title":"disabled","text":"

\u2022 Optional disabled: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#overrides","title":"Overrides","text":"

React.HTMLProps.disabled

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#href","title":"href","text":"

\u2022 Optional href: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#overrides_1","title":"Overrides","text":"

React.HTMLProps.href

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#icon","title":"icon","text":"

\u2022 Optional icon: string | Partial<IconProps>

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#spacer","title":"spacer","text":"

\u2022 Optional spacer: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/","title":"Renderer.Component.MenuPosition","text":"

@k8slens/extensions / Exports / Renderer / Component / MenuPosition

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#interface-menuposition","title":"Interface: MenuPosition","text":"

Renderer.Component.MenuPosition

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#properties","title":"Properties","text":"
  • bottom
  • left
  • right
  • top
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#bottom","title":"bottom","text":"

\u2022 Optional bottom: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#left","title":"left","text":"

\u2022 Optional left: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#right","title":"right","text":"

\u2022 Optional right: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#top","title":"top","text":"

\u2022 Optional top: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/","title":"Renderer.Component.MenuProps","text":"

@k8slens/extensions / Exports / Renderer / Component / MenuProps

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#interface-menuprops","title":"Interface: MenuProps","text":"

Renderer.Component.MenuProps

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#properties","title":"Properties","text":"
  • animated
  • autoFocus
  • children
  • className
  • closeOnClickItem
  • closeOnClickOutside
  • closeOnScroll
  • data-testid
  • htmlFor
  • id
  • isOpen
  • position
  • toggleEvent
  • usePortal
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#methods","title":"Methods","text":"
  • close
  • open
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#animated","title":"animated","text":"

\u2022 Optional animated: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#autofocus","title":"autoFocus","text":"

\u2022 Optional autoFocus: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#children","title":"children","text":"

\u2022 Optional children: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#closeonclickitem","title":"closeOnClickItem","text":"

\u2022 Optional closeOnClickItem: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#closeonclickoutside","title":"closeOnClickOutside","text":"

\u2022 Optional closeOnClickOutside: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#closeonscroll","title":"closeOnScroll","text":"

\u2022 Optional closeOnScroll: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#data-testid","title":"data-testid","text":"

\u2022 Optional data-testid: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#htmlfor","title":"htmlFor","text":"

\u2022 Optional htmlFor: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#id","title":"id","text":"

\u2022 Optional id: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#isopen","title":"isOpen","text":"

\u2022 Optional isOpen: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#position","title":"position","text":"

\u2022 Optional position: MenuPosition

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#toggleevent","title":"toggleEvent","text":"

\u2022 Optional toggleEvent: \"click\" | \"contextmenu\"

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#useportal","title":"usePortal","text":"

\u2022 Optional usePortal: boolean | HTMLElement

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#close","title":"close","text":"

\u25b8 close(): void

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#open","title":"open","text":"

\u25b8 open(): void

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/","title":"Renderer.Component.MenuStyle","text":"

@k8slens/extensions / Exports / Renderer / Component / MenuStyle

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/#interface-menustyle","title":"Interface: MenuStyle","text":"

Renderer.Component.MenuStyle

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/#properties","title":"Properties","text":"
  • left
  • top
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/#left","title":"left","text":"

\u2022 left: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/#top","title":"top","text":"

\u2022 top: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/","title":"Renderer.Component.MonacoEditorProps","text":"

@k8slens/extensions / Exports / Renderer / Component / MonacoEditorProps

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#interface-monacoeditorprops","title":"Interface: MonacoEditorProps","text":"

Renderer.Component.MonacoEditorProps

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#properties","title":"Properties","text":"
  • autoFocus
  • className
  • id
  • innerRef
  • language
  • options
  • readOnly
  • setInitialHeight
  • style
  • theme
  • value
"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#methods","title":"Methods","text":"
  • onChange
  • onDidContentSizeChange
  • onDidLayoutChange
  • onError
  • onModelChange
"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#autofocus","title":"autoFocus","text":"

\u2022 Optional autoFocus: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#id","title":"id","text":"

\u2022 Optional id: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#innerref","title":"innerRef","text":"

\u2022 Optional innerRef: ForwardedRef<MonacoEditorRef>

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#language","title":"language","text":"

\u2022 Optional language: \"yaml\" | \"json\"

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#options","title":"options","text":"

\u2022 Optional options: Partial<IStandaloneEditorConstructionOptions>

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#readonly","title":"readOnly","text":"

\u2022 Optional readOnly: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#setinitialheight","title":"setInitialHeight","text":"

\u2022 Optional setInitialHeight: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#style","title":"style","text":"

\u2022 Optional style: CSSProperties

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#theme","title":"theme","text":"

\u2022 Optional theme: MonacoTheme

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#value","title":"value","text":"

\u2022 value: string

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#onchange","title":"onChange","text":"

\u25b8 Optional onChange(value, evt): void

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#parameters","title":"Parameters","text":"Name Type value string evt IModelContentChangedEvent"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#ondidcontentsizechange","title":"onDidContentSizeChange","text":"

\u25b8 Optional onDidContentSizeChange(evt): void

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#parameters_1","title":"Parameters","text":"Name Type evt IContentSizeChangedEvent"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#ondidlayoutchange","title":"onDidLayoutChange","text":"

\u25b8 Optional onDidLayoutChange(info): void

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#parameters_2","title":"Parameters","text":"Name Type info EditorLayoutInfo"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#onerror","title":"onError","text":"

\u25b8 Optional onError(error): void

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#parameters_3","title":"Parameters","text":"Name Type error unknown"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#onmodelchange","title":"onModelChange","text":"

\u25b8 Optional onModelChange(model, prev?): void

"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#parameters_4","title":"Parameters","text":"Name Type model ITextModel prev? ITextModel"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#returns_4","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/","title":"Renderer.Component.NamespaceSelectProps","text":"

@k8slens/extensions / Exports / Renderer / Component / NamespaceSelectProps

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#interface-namespaceselectpropsismulti","title":"Interface: NamespaceSelectProps<IsMulti>","text":"

Renderer.Component.NamespaceSelectProps

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#type-parameters","title":"Type parameters","text":"Name Type IsMulti extends boolean"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#hierarchy","title":"Hierarchy","text":"
  • Omit<SelectProps<string, { label: string ; value: string }, IsMulti>, \"options\" | \"value\">

\u21b3 NamespaceSelectProps

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#properties","title":"Properties","text":"
  • autoConvertOptions
  • id
  • isCreatable
  • menuClass
  • showIcons
  • sort
  • themeName
  • value
"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#autoconvertoptions","title":"autoConvertOptions","text":"

\u2022 Optional autoConvertOptions: boolean

Deprecated

We will always auto convert options if they are of type string

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#inherited-from","title":"Inherited from","text":"

Omit.autoConvertOptions

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#id","title":"id","text":"

\u2022 Optional id: string

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#inherited-from_1","title":"Inherited from","text":"

Omit.id

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#iscreatable","title":"isCreatable","text":"

\u2022 Optional isCreatable: boolean

Deprecated

This option does nothing

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#inherited-from_2","title":"Inherited from","text":"

Omit.isCreatable

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#menuclass","title":"menuClass","text":"

\u2022 Optional menuClass: string

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#inherited-from_3","title":"Inherited from","text":"

Omit.menuClass

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#showicons","title":"showIcons","text":"

\u2022 Optional showIcons: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#sort","title":"sort","text":"

\u2022 Optional sort: NamespaceSelectSort

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#themename","title":"themeName","text":"

\u2022 Optional themeName: \"dark\" | \"light\" | \"outlined\" | \"lens\"

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#inherited-from_4","title":"Inherited from","text":"

Omit.themeName

"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#value","title":"value","text":"

\u2022 value: undefined | null | string

"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/","title":"Renderer.Component.Notification","text":"

@k8slens/extensions / Exports / Renderer / Component / Notification

"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#interface-notification","title":"Interface: Notification","text":"

Renderer.Component.Notification

"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#properties","title":"Properties","text":"
  • id
  • message
  • status
  • timeout
"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#methods","title":"Methods","text":"
  • onClose
"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#id","title":"id","text":"

\u2022 Optional id: NotificationId

"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#message","title":"message","text":"

\u2022 message: NotificationMessage

"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#status","title":"status","text":"

\u2022 Optional status: NotificationStatus

"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#timeout","title":"timeout","text":"

\u2022 Optional timeout: number

"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#onclose","title":"onClose","text":"

\u25b8 Optional onClose(): void

"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/","title":"Renderer.Component.PieChartData","text":"

@k8slens/extensions / Exports / Renderer / Component / PieChartData

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/#interface-piechartdata","title":"Interface: PieChartData","text":"

Renderer.Component.PieChartData

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/#hierarchy","title":"Hierarchy","text":"
  • ChartData

\u21b3 PieChartData

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/#properties","title":"Properties","text":"
  • datasets
"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/#datasets","title":"datasets","text":"

\u2022 Optional datasets: PieChartDataSets[]

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/#overrides","title":"Overrides","text":"

ChartJS.ChartData.datasets

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/","title":"Renderer.Component.PieChartProps","text":"

@k8slens/extensions / Exports / Renderer / Component / PieChartProps

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#interface-piechartprops","title":"Interface: PieChartProps","text":"

Renderer.Component.PieChartProps

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#hierarchy","title":"Hierarchy","text":"
  • ChartProps

\u21b3 PieChartProps

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#properties","title":"Properties","text":"
  • className
  • data
  • data-testid
  • height
  • legendColors
  • legendPosition
  • options
  • plugins
  • redraw
  • showChart
  • showLegend
  • title
  • type
  • width
"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#inherited-from","title":"Inherited from","text":"

ChartProps.className

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#data","title":"data","text":"

\u2022 data: ChartData

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#inherited-from_1","title":"Inherited from","text":"

ChartProps.data

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#data-testid","title":"data-testid","text":"

\u2022 Optional data-testid: string

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#inherited-from_2","title":"Inherited from","text":"

ChartProps.data-testid

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#height","title":"height","text":"

\u2022 Optional height: string | number

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#inherited-from_3","title":"Inherited from","text":"

ChartProps.height

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#legendcolors","title":"legendColors","text":"

\u2022 Optional legendColors: string[]

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#inherited-from_4","title":"Inherited from","text":"

ChartProps.legendColors

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#legendposition","title":"legendPosition","text":"

\u2022 Optional legendPosition: \"bottom\"

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#inherited-from_5","title":"Inherited from","text":"

ChartProps.legendPosition

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#options","title":"options","text":"

\u2022 Optional options: ChartOptions

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#inherited-from_6","title":"Inherited from","text":"

ChartProps.options

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#plugins","title":"plugins","text":"

\u2022 Optional plugins: PluginServiceRegistrationOptions[]

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#inherited-from_7","title":"Inherited from","text":"

ChartProps.plugins

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#redraw","title":"redraw","text":"

\u2022 Optional redraw: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#inherited-from_8","title":"Inherited from","text":"

ChartProps.redraw

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#showchart","title":"showChart","text":"

\u2022 Optional showChart: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#inherited-from_9","title":"Inherited from","text":"

ChartProps.showChart

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#showlegend","title":"showLegend","text":"

\u2022 Optional showLegend: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#inherited-from_10","title":"Inherited from","text":"

ChartProps.showLegend

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#title","title":"title","text":"

\u2022 Optional title: string

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#inherited-from_11","title":"Inherited from","text":"

ChartProps.title

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#type","title":"type","text":"

\u2022 Optional type: ChartKind

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#inherited-from_12","title":"Inherited from","text":"

ChartProps.type

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#width","title":"width","text":"

\u2022 Optional width: string | number

"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#inherited-from_13","title":"Inherited from","text":"

ChartProps.width

"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/","title":"Renderer.Component.PodDetailsListProps","text":"

@k8slens/extensions / Exports / Renderer / Component / PodDetailsListProps

"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#interface-poddetailslistprops","title":"Interface: PodDetailsListProps","text":"

Renderer.Component.PodDetailsListProps

"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#properties","title":"Properties","text":"
  • maxCpu
  • maxMemory
  • owner
  • pods
"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#maxcpu","title":"maxCpu","text":"

\u2022 Optional maxCpu: number

"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#maxmemory","title":"maxMemory","text":"

\u2022 Optional maxMemory: number

"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#owner","title":"owner","text":"

\u2022 owner: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#pods","title":"pods","text":"

\u2022 pods: Pod[]

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/","title":"Renderer.Component.RadioGroupProps","text":"

@k8slens/extensions / Exports / Renderer / Component / RadioGroupProps

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#interface-radiogrouppropst","title":"Interface: RadioGroupProps<T>","text":"

Renderer.Component.RadioGroupProps

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#type-parameters","title":"Type parameters","text":"Name T"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#properties","title":"Properties","text":"
  • asButtons
  • children
  • className
  • disabled
  • onChange
  • value
"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#asbuttons","title":"asButtons","text":"

\u2022 Optional asButtons: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#children","title":"children","text":"

\u2022 children: SingleOrMany<ReactElement<RadioProps<T>, string | JSXElementConstructor<any>>>

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#disabled","title":"disabled","text":"

\u2022 Optional disabled: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#onchange","title":"onChange","text":"

\u2022 onChange: (value: T) => void

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#type-declaration","title":"Type declaration","text":"

\u25b8 (value): void

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#parameters","title":"Parameters","text":"Name Type value T"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#value","title":"value","text":"

\u2022 Optional value: T

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/","title":"Renderer.Component.RadioProps","text":"

@k8slens/extensions / Exports / Renderer / Component / RadioProps

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#interface-radiopropst","title":"Interface: RadioProps<T>","text":"

Renderer.Component.RadioProps

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#type-parameters","title":"Type parameters","text":"Name T"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#properties","title":"Properties","text":"
  • className
  • disabled
  • label
  • value
"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#disabled","title":"disabled","text":"

\u2022 Optional disabled: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#label","title":"label","text":"

\u2022 label: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#value","title":"value","text":"

\u2022 value: T

"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/","title":"Renderer.Component.ResourceMetricsProps","text":"

@k8slens/extensions / Exports / Renderer / Component / ResourceMetricsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/#interface-resourcemetricspropskeys","title":"Interface: ResourceMetricsProps<Keys>","text":"

Renderer.Component.ResourceMetricsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/#type-parameters","title":"Type parameters","text":"Name Type Keys extends string"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/#properties","title":"Properties","text":"
  • children
  • className
  • metrics
  • object
  • tabs
"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/#children","title":"children","text":"

\u2022 children: ReactChild | ReactChild[]

"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/#metrics","title":"metrics","text":"

\u2022 metrics: Partial<Record<Keys, MetricData>> | IAsyncComputed<undefined | null | Partial<Record<Keys, MetricData>>>

"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/#object","title":"object","text":"

\u2022 object: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/#tabs","title":"tabs","text":"

\u2022 tabs: AtLeastOneMetricTab

"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsValue/","title":"Renderer.Component.ResourceMetricsValue","text":"

@k8slens/extensions / Exports / Renderer / Component / ResourceMetricsValue

"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsValue/#interface-resourcemetricsvalue","title":"Interface: ResourceMetricsValue","text":"

Renderer.Component.ResourceMetricsValue

"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsValue/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsValue/#properties","title":"Properties","text":"
  • metrics
  • object
  • tab
"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsValue/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsValue/#metrics","title":"metrics","text":"

\u2022 metrics: undefined | null | Partial<Record<string, MetricData>>

"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsValue/#object","title":"object","text":"

\u2022 object: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>

"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsValue/#tab","title":"tab","text":"

\u2022 tab: MetricsTab

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/","title":"Renderer.Component.SearchInputProps","text":"

@k8slens/extensions / Exports / Renderer / Component / SearchInputProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#interface-searchinputprops","title":"Interface: SearchInputProps","text":"

Renderer.Component.SearchInputProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#hierarchy","title":"Hierarchy","text":"
  • InputProps

\u21b3 SearchInputProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#properties","title":"Properties","text":"
  • autoSelectOnFocus
  • bindGlobalFocusHotkey
  • blurOnEnter
  • compact
  • contentRight
  • dirty
  • iconLeft
  • iconRight
  • maxRows
  • multiLine
  • showClearIcon
  • showErrorsAsTooltip
  • showValidationLine
  • theme
  • trim
  • validators
"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#methods","title":"Methods","text":"
  • onChange
  • onClear
  • onSubmit
"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#autoselectonfocus","title":"autoSelectOnFocus","text":"

\u2022 Optional autoSelectOnFocus: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from","title":"Inherited from","text":"

InputProps.autoSelectOnFocus

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#bindglobalfocushotkey","title":"bindGlobalFocusHotkey","text":"

\u2022 Optional bindGlobalFocusHotkey: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#bluronenter","title":"blurOnEnter","text":"

\u2022 Optional blurOnEnter: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from_1","title":"Inherited from","text":"

InputProps.blurOnEnter

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#compact","title":"compact","text":"

\u2022 Optional compact: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#contentright","title":"contentRight","text":"

\u2022 Optional contentRight: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from_2","title":"Inherited from","text":"

InputProps.contentRight

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#dirty","title":"dirty","text":"

\u2022 Optional dirty: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from_3","title":"Inherited from","text":"

InputProps.dirty

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#iconleft","title":"iconLeft","text":"

\u2022 Optional iconLeft: IconData

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from_4","title":"Inherited from","text":"

InputProps.iconLeft

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#iconright","title":"iconRight","text":"

\u2022 Optional iconRight: IconData

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from_5","title":"Inherited from","text":"

InputProps.iconRight

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#maxrows","title":"maxRows","text":"

\u2022 Optional maxRows: number

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from_6","title":"Inherited from","text":"

InputProps.maxRows

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#multiline","title":"multiLine","text":"

\u2022 Optional multiLine: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from_7","title":"Inherited from","text":"

InputProps.multiLine

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#showclearicon","title":"showClearIcon","text":"

\u2022 Optional showClearIcon: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#showerrorsastooltip","title":"showErrorsAsTooltip","text":"

\u2022 Optional showErrorsAsTooltip: boolean | Omit<TooltipProps, \"targetId\">

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from_8","title":"Inherited from","text":"

InputProps.showErrorsAsTooltip

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#showvalidationline","title":"showValidationLine","text":"

\u2022 Optional showValidationLine: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from_9","title":"Inherited from","text":"

InputProps.showValidationLine

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#theme","title":"theme","text":"

\u2022 Optional theme: \"round-black\" | \"round\"

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from_10","title":"Inherited from","text":"

InputProps.theme

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#trim","title":"trim","text":"

\u2022 Optional trim: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from_11","title":"Inherited from","text":"

InputProps.trim

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#validators","title":"validators","text":"

\u2022 Optional validators: SingleOrMany<InputValidator<boolean>>

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from_12","title":"Inherited from","text":"

InputProps.validators

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#onchange","title":"onChange","text":"

\u25b8 Optional onChange(value, evt): void

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#parameters","title":"Parameters","text":"Name Type value string evt ChangeEvent<InputElement>"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from_13","title":"Inherited from","text":"

InputProps.onChange

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#onclear","title":"onClear","text":"

\u25b8 Optional onClear(): void

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#onsubmit","title":"onSubmit","text":"

\u25b8 Optional onSubmit(value, evt): void

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#parameters_1","title":"Parameters","text":"Name Type value string evt KeyboardEvent<InputElement>"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#inherited-from_14","title":"Inherited from","text":"

InputProps.onSubmit

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/","title":"Renderer.Component.SelectOption","text":"

@k8slens/extensions / Exports / Renderer / Component / SelectOption

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#interface-selectoptionvalue","title":"Interface: SelectOption<Value>","text":"

Renderer.Component.SelectOption

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#type-parameters","title":"Type parameters","text":"Name Value"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#properties","title":"Properties","text":"
  • id
  • isDisabled
  • isSelected
  • label
  • value
"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#id","title":"id","text":"

\u2022 Optional id: string

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#isdisabled","title":"isDisabled","text":"

\u2022 Optional isDisabled: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#isselected","title":"isSelected","text":"

\u2022 Optional isSelected: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#label","title":"label","text":"

\u2022 label: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#value","title":"value","text":"

\u2022 value: Value

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/","title":"Renderer.Component.SelectProps","text":"

@k8slens/extensions / Exports / Renderer / Component / SelectProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#interface-selectpropsvalue-option-ismulti-group","title":"Interface: SelectProps<Value, Option, IsMulti, Group>","text":"

Renderer.Component.SelectProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#type-parameters","title":"Type parameters","text":"Name Type Value Value Option extends SelectOption<Value> IsMulti extends boolean Group extends GroupBase<Option> = GroupBase<Option>"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#hierarchy","title":"Hierarchy","text":"
  • Omit<ReactSelectProps<Option, IsMulti, Group>, \"value\" | \"options\">

\u21b3 SelectProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#properties","title":"Properties","text":"
  • autoConvertOptions
  • id
  • isCreatable
  • menuClass
  • options
  • themeName
  • value
"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#autoconvertoptions","title":"autoConvertOptions","text":"

\u2022 Optional autoConvertOptions: boolean

Deprecated

We will always auto convert options if they are of type string

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#id","title":"id","text":"

\u2022 Optional id: string

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#overrides","title":"Overrides","text":"

Omit.id

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#iscreatable","title":"isCreatable","text":"

\u2022 Optional isCreatable: boolean

Deprecated

This option does nothing

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#menuclass","title":"menuClass","text":"

\u2022 Optional menuClass: string

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#options","title":"options","text":"

\u2022 options: OptionsOrGroups<Option, Group> | LegacyAutoConvertedOptions

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#themename","title":"themeName","text":"

\u2022 Optional themeName: \"dark\" | \"light\" | \"outlined\" | \"lens\"

"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#value","title":"value","text":"

\u2022 Optional value: PropsValue<Value>

"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/","title":"Renderer.Component.SettingLayoutProps","text":"

@k8slens/extensions / Exports / Renderer / Component / SettingLayoutProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#interface-settinglayoutprops","title":"Interface: SettingLayoutProps","text":"

Renderer.Component.SettingLayoutProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#hierarchy","title":"Hierarchy","text":"
  • DOMAttributes<any>

\u21b3 SettingLayoutProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#properties","title":"Properties","text":"
  • back
  • className
  • closeButtonProps
  • contentClass
  • contentGaps
  • navigation
  • provideBackButtonNavigation
"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#back","title":"back","text":"

\u2022 Optional back: (evt: MouseEvent<Element, MouseEvent> | KeyboardEvent) => void

"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#type-declaration","title":"Type declaration","text":"

\u25b8 (evt): void

"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#parameters","title":"Parameters","text":"Name Type evt MouseEvent<Element, MouseEvent> | KeyboardEvent"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#classname","title":"className","text":"

\u2022 Optional className: IClassName

"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#closebuttonprops","title":"closeButtonProps","text":"

\u2022 Optional closeButtonProps: Object

"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#type-declaration_1","title":"Type declaration","text":"Name Type data-testid? string"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#contentclass","title":"contentClass","text":"

\u2022 Optional contentClass: IClassName

"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#contentgaps","title":"contentGaps","text":"

\u2022 Optional contentGaps: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#navigation","title":"navigation","text":"

\u2022 Optional navigation: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#providebackbuttonnavigation","title":"provideBackButtonNavigation","text":"

\u2022 Optional provideBackButtonNavigation: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/","title":"Renderer.Component.SliderProps","text":"

@k8slens/extensions / Exports / Renderer / Component / SliderProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#interface-sliderprops","title":"Interface: SliderProps","text":"

Renderer.Component.SliderProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#hierarchy","title":"Hierarchy","text":"
  • Omit<MaterialSliderProps, \"onChange\">

\u21b3 SliderProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#properties","title":"Properties","text":"
  • className
"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#methods","title":"Methods","text":"
  • onChange
"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#overrides","title":"Overrides","text":"

Omit.className

"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#onchange","title":"onChange","text":"

\u25b8 onChange(evt, value): void

"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#parameters","title":"Parameters","text":"Name Type evt FormEvent<any> value number"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/","title":"Renderer.Component.SpinnerProps","text":"

@k8slens/extensions / Exports / Renderer / Component / SpinnerProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#interface-spinnerprops","title":"Interface: SpinnerProps","text":"

Renderer.Component.SpinnerProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#hierarchy","title":"Hierarchy","text":"
  • HTMLProps<any>

\u21b3 SpinnerProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#properties","title":"Properties","text":"
  • center
  • singleColor
"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#center","title":"center","text":"

\u2022 Optional center: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#singlecolor","title":"singleColor","text":"

\u2022 Optional singleColor: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.StatusBrickProps/","title":"Renderer.Component.StatusBrickProps","text":"

@k8slens/extensions / Exports / Renderer / Component / StatusBrickProps

"},{"location":"extensions/api/interfaces/Renderer.Component.StatusBrickProps/#interface-statusbrickprops","title":"Interface: StatusBrickProps","text":"

Renderer.Component.StatusBrickProps

"},{"location":"extensions/api/interfaces/Renderer.Component.StatusBrickProps/#hierarchy","title":"Hierarchy","text":"
  • HTMLAttributes<HTMLDivElement>

\u21b3 StatusBrickProps

"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/","title":"Renderer.Component.StepperProps","text":"

@k8slens/extensions / Exports / Renderer / Component / StepperProps

"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#interface-stepperprops","title":"Interface: StepperProps","text":"

Renderer.Component.StepperProps

"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#hierarchy","title":"Hierarchy","text":"
  • HTMLProps<any>

\u21b3 StepperProps

"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#properties","title":"Properties","text":"
  • step
  • steps
"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#step","title":"step","text":"

\u2022 step: number

"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#overrides","title":"Overrides","text":"

React.HTMLProps.step

"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#steps","title":"steps","text":"

\u2022 steps: Step[]

"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/","title":"Renderer.Component.SubTitleProps","text":"

@k8slens/extensions / Exports / Renderer / Component / SubTitleProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#interface-subtitleprops","title":"Interface: SubTitleProps","text":"

Renderer.Component.SubTitleProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#properties","title":"Properties","text":"
  • children
  • className
  • compact
  • id
  • title
"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#children","title":"children","text":"

\u2022 Optional children: SingleOrMany<ReactNode>

"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#compact","title":"compact","text":"

\u2022 Optional compact: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#id","title":"id","text":"

\u2022 Optional id: string

"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#title","title":"title","text":"

\u2022 title: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/","title":"Renderer.Component.SwitchProps","text":"

@k8slens/extensions / Exports / Renderer / Component / SwitchProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#interface-switchprops","title":"Interface: SwitchProps","text":"

Renderer.Component.SwitchProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#hierarchy","title":"Hierarchy","text":"
  • Omit<HTMLProps<HTMLInputElement>, \"onChange\">

\u21b3 SwitchProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#properties","title":"Properties","text":"
  • onChange
"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#onchange","title":"onChange","text":"

\u2022 Optional onChange: (checked: boolean, event: ChangeEvent<HTMLInputElement>) => void

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#type-declaration","title":"Type declaration","text":"

\u25b8 (checked, event): void

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#parameters","title":"Parameters","text":"Name Type checked boolean event ChangeEvent<HTMLInputElement>"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/","title":"Renderer.Component.SwitcherProps","text":"

@k8slens/extensions / Exports / Renderer / Component / SwitcherProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#interface-switcherprops","title":"Interface: SwitcherProps","text":"

Renderer.Component.SwitcherProps

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#properties","title":"Properties","text":"
  • checked
  • children
  • disabled
  • name
  • onChange
"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#checked","title":"checked","text":"

\u2022 Optional checked: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#children","title":"children","text":"

\u2022 Optional children: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#disabled","title":"disabled","text":"

\u2022 Optional disabled: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#name","title":"name","text":"

\u2022 Optional name: string

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#onchange","title":"onChange","text":"

\u2022 Optional onChange: (event: ChangeEvent<HTMLInputElement>, checked: boolean) => void

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#type-declaration","title":"Type declaration","text":"

\u25b8 (event, checked): void

"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#parameters","title":"Parameters","text":"Name Type event ChangeEvent<HTMLInputElement> checked boolean"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/","title":"Renderer.Component.TabLayoutProps","text":"

@k8slens/extensions / Exports / Renderer / Component / TabLayoutProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#interface-tablayoutprops","title":"Interface: TabLayoutProps","text":"

Renderer.Component.TabLayoutProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#properties","title":"Properties","text":"
  • children
  • className
  • contentClass
  • scrollable
  • tabs
"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#children","title":"children","text":"

\u2022 Optional children: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#classname","title":"className","text":"

\u2022 Optional className: IClassName

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#contentclass","title":"contentClass","text":"

\u2022 Optional contentClass: IClassName

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#scrollable","title":"scrollable","text":"

\u2022 Optional scrollable: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#tabs","title":"tabs","text":"

\u2022 Optional tabs: TabLayoutRoute[]

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/","title":"Renderer.Component.TabLayoutRoute","text":"

@k8slens/extensions / Exports / Renderer / Component / TabLayoutRoute

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#interface-tablayoutroute","title":"Interface: TabLayoutRoute","text":"

Renderer.Component.TabLayoutRoute

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#properties","title":"Properties","text":"
  • component
  • default
  • exact
  • routePath
  • title
  • url
"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#component","title":"component","text":"

\u2022 component: ComponentType<any>

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#default","title":"default","text":"

\u2022 Optional default: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#exact","title":"exact","text":"

\u2022 Optional exact: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#routepath","title":"routePath","text":"

\u2022 routePath: string

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#title","title":"title","text":"

\u2022 title: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#url","title":"url","text":"

\u2022 Optional url: string

"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/","title":"Renderer.Component.TabProps","text":"

@k8slens/extensions / Exports / Renderer / Component / TabProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#interface-tabpropsd","title":"Interface: TabProps<D>","text":"

Renderer.Component.TabProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#type-parameters","title":"Type parameters","text":"Name D"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#hierarchy","title":"Hierarchy","text":"
  • DOMAttributes<HTMLElement>

\u21b3 TabProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#properties","title":"Properties","text":"
  • active
  • className
  • disabled
  • icon
  • id
  • label
  • value
"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#active","title":"active","text":"

\u2022 Optional active: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#disabled","title":"disabled","text":"

\u2022 Optional disabled: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#icon","title":"icon","text":"

\u2022 Optional icon: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#id","title":"id","text":"

\u2022 Optional id: string

"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#label","title":"label","text":"

\u2022 Optional label: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#value","title":"value","text":"

\u2022 value: D

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/","title":"Renderer.Component.TableCellProps","text":"

@k8slens/extensions / Exports / Renderer / Component / TableCellProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#interface-tablecellprops","title":"Interface: TableCellProps","text":"

Renderer.Component.TableCellProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#hierarchy","title":"Hierarchy","text":"
  • DOMAttributes<HTMLDivElement>

\u21b3 TableCellProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#properties","title":"Properties","text":"
  • _nowrap
  • _sorting
  • checkbox
  • className
  • data-testid
  • id
  • isChecked
  • scrollable
  • showWithColumn
  • sortBy
  • title
"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#methods","title":"Methods","text":"
  • _sort
"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#_nowrap","title":"_nowrap","text":"

\u2022 Optional _nowrap: boolean

indicator, might come from parent , don't use this prop outside (!)"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#_sorting","title":"_sorting","text":"

\u2022 Optional _sorting: Partial<TableSortParams>

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#checkbox","title":"checkbox","text":"

\u2022 Optional checkbox: boolean

render cell with a checkbox

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#classname","title":"className","text":"

\u2022 Optional className: string

Any css class names for this table cell. Only used if title is a \"simple\" react node

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#data-testid","title":"data-testid","text":"

\u2022 Optional data-testid: string

For passing in the testid

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#id","title":"id","text":"

\u2022 Optional id: string

used for configuration visibility of columns

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#ischecked","title":"isChecked","text":"

\u2022 Optional isChecked: boolean

mark checkbox as checked or not

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#scrollable","title":"scrollable","text":"

\u2022 Optional scrollable: boolean

content inside could be scrolled

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#showwithcolumn","title":"showWithColumn","text":"

\u2022 Optional showWithColumn: string

id of the column which follow same visibility rules

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#sortby","title":"sortBy","text":"

\u2022 Optional sortBy: string

column name, must be same as key in sortable object <Table sortable={}></Table>

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#title","title":"title","text":"

\u2022 Optional title: ReactNode

The actual value of the cell

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#_sort","title":"_sort","text":"

\u25b8 Optional _sort(sortBy): void

"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#parameters","title":"Parameters","text":"Name Type sortBy string"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/","title":"Renderer.Component.TableHeadProps","text":"

@k8slens/extensions / Exports / Renderer / Component / TableHeadProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#interface-tableheadprops","title":"Interface: TableHeadProps","text":"

Renderer.Component.TableHeadProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#hierarchy","title":"Hierarchy","text":"
  • DOMAttributes<HTMLDivElement>

\u21b3 TableHeadProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#properties","title":"Properties","text":"
  • className
  • flat
  • nowrap
  • showTopLine
  • sticky
"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#flat","title":"flat","text":"

\u2022 Optional flat: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#nowrap","title":"nowrap","text":"

\u2022 Optional nowrap: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#showtopline","title":"showTopLine","text":"

\u2022 Optional showTopLine: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#sticky","title":"sticky","text":"

\u2022 Optional sticky: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/","title":"Renderer.Component.TableProps","text":"

@k8slens/extensions / Exports / Renderer / Component / TableProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#interface-tablepropsitem","title":"Interface: TableProps<Item>","text":"

Renderer.Component.TableProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#type-parameters","title":"Type parameters","text":"Name Item"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#hierarchy","title":"Hierarchy","text":"
  • DOMAttributes<HTMLDivElement>

\u21b3 TableProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#properties","title":"Properties","text":"
  • autoSize
  • className
  • customRowHeights
  • getTableRow
  • items
  • noItems
  • onSort
  • renderRow
  • rowLineHeight
  • rowPadding
  • scrollable
  • selectable
  • selectedItemId
  • sortByDefault
  • sortSyncWithUrl
  • sortable
  • storageKey
  • tableId
  • virtual
  • virtualHeight
"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#autosize","title":"autoSize","text":"

\u2022 Optional autoSize: boolean

Setup auto-sizing for all columns (flex: 1 0)

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#classname","title":"className","text":"

\u2022 Optional className: string

Optional addition class names for the root HTML element

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#customrowheights","title":"customRowHeights","text":"

\u2022 Optional customRowHeights: (item: Item, lineHeight: number, paddings: number) => number

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#type-declaration","title":"Type declaration","text":"

\u25b8 (item, lineHeight, paddings): number

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#parameters","title":"Parameters","text":"Name Type item Item lineHeight number paddings number"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#returns","title":"Returns","text":"

number

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#gettablerow","title":"getTableRow","text":"

\u2022 Optional getTableRow: (uid: string) => undefined | null | ReactElement<TableRowProps<Item>, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (uid): undefined | null | ReactElement<TableRowProps<Item>, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#parameters_1","title":"Parameters","text":"Name Type uid string"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#returns_1","title":"Returns","text":"

undefined | null | ReactElement<TableRowProps<Item>, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#items","title":"items","text":"

\u2022 Optional items: Item[]

The raw data for the table

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#noitems","title":"noItems","text":"

\u2022 Optional noItems: ReactNode

This is shown when items is empty

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#onsort","title":"onSort","text":"

\u2022 Optional onSort: (params: TableSortParams) => void

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (params): void

callback on sort change

Default: global sync with url

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#parameters_2","title":"Parameters","text":"Name Type params TableSortParams"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#renderrow","title":"renderRow","text":"

\u2022 Optional renderRow: (item: Item) => undefined | null | ReactElement<TableRowProps<Item>, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (item): undefined | null | ReactElement<TableRowProps<Item>, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#parameters_3","title":"Parameters","text":"Name Type item Item"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#returns_3","title":"Returns","text":"

undefined | null | ReactElement<TableRowProps<Item>, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#rowlineheight","title":"rowLineHeight","text":"

\u2022 Optional rowLineHeight: number

Row line height in pixels

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#rowpadding","title":"rowPadding","text":"

\u2022 Optional rowPadding: number

Row padding in pixels

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#scrollable","title":"scrollable","text":"

\u2022 Optional scrollable: boolean

Use scrollbar if content is bigger than parent's height

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#selectable","title":"selectable","text":"

\u2022 Optional selectable: boolean

Highlight rows on hover

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#selecteditemid","title":"selectedItemId","text":"

\u2022 Optional selectedItemId: string

Allows to scroll list to selected item

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#sortbydefault","title":"sortByDefault","text":"

\u2022 Optional sortByDefault: Partial<TableSortParams>

default sorting params

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#sortsyncwithurl","title":"sortSyncWithUrl","text":"

\u2022 Optional sortSyncWithUrl: boolean

sorting state is managed globally from url params

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#sortable","title":"sortable","text":"

\u2022 Optional sortable: TableSortCallbacks<Item>

Define sortable callbacks for every column in <TableHead><TableCell sortBy=\"someCol\"></TableCell></TableHead>

Sort Item

argument in the callback is an object, provided in <TableRow sortItem={someColDataItem}></TableRow>

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#storagekey","title":"storageKey","text":"

\u2022 Optional storageKey: string

Deprecated

Unused

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#tableid","title":"tableId","text":"

\u2022 Optional tableId: string

Used for persisting sort order and visible columns

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#virtual","title":"virtual","text":"

\u2022 Optional virtual: boolean

Use virtual list component to render only visible rows. By default uses a auto sizer to fill available height

"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#virtualheight","title":"virtualHeight","text":"

\u2022 Optional virtualHeight: number

Only used when virtual is true. Sets the virtual list to be a fixed height. Needed when used in contexts that already have a parent component that is overflow-y: scroll,

"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/","title":"Renderer.Component.TableRowProps","text":"

@k8slens/extensions / Exports / Renderer / Component / TableRowProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#interface-tablerowpropsitem","title":"Interface: TableRowProps<Item>","text":"

Renderer.Component.TableRowProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#type-parameters","title":"Type parameters","text":"Name Item"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#hierarchy","title":"Hierarchy","text":"
  • DOMAttributes<HTMLDivElement>

\u21b3 TableRowProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#properties","title":"Properties","text":"
  • className
  • disabled
  • nowrap
  • searchItem
  • selected
  • sortItem
  • style
  • testId
"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#disabled","title":"disabled","text":"

\u2022 Optional disabled: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#nowrap","title":"nowrap","text":"

\u2022 Optional nowrap: boolean

Should the inner <TableCell> be aligned to one line white-space: nowrap

"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#searchitem","title":"searchItem","text":"

\u2022 Optional searchItem: Item

data for searching filters in <Table searchable={}></Table>

"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#selected","title":"selected","text":"

\u2022 Optional selected: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#sortitem","title":"sortItem","text":"

\u2022 Optional sortItem: Item

data for sorting callback in <Table sortable={}></Table>

"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#style","title":"style","text":"

\u2022 Optional style: CSSProperties

"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#testid","title":"testId","text":"

\u2022 Optional testId: string

"},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/","title":"Renderer.Component.TableSortParams","text":"

@k8slens/extensions / Exports / Renderer / Component / TableSortParams

"},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/#interface-tablesortparams","title":"Interface: TableSortParams","text":"

Renderer.Component.TableSortParams

"},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/#properties","title":"Properties","text":"
  • orderBy
  • sortBy
"},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/#orderby","title":"orderBy","text":"

\u2022 orderBy: TableOrderBy

"},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/#sortby","title":"sortBy","text":"

\u2022 sortBy: string

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/","title":"Renderer.Component.TabsProps","text":"

@k8slens/extensions / Exports / Renderer / Component / TabsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#interface-tabspropsd","title":"Interface: TabsProps<D>","text":"

Renderer.Component.TabsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#type-parameters","title":"Type parameters","text":"Name D"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#hierarchy","title":"Hierarchy","text":"
  • TabsContextValue<D>

  • Omit<DOMAttributes<HTMLElement>, \"onChange\">

\u21b3 TabsProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#properties","title":"Properties","text":"
  • autoFocus
  • center
  • className
  • scrollable
  • value
  • withBorder
  • wrap
"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#methods","title":"Methods","text":"
  • onChange
"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#autofocus","title":"autoFocus","text":"

\u2022 Optional autoFocus: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#inherited-from","title":"Inherited from","text":"

TabsContextValue.autoFocus

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#center","title":"center","text":"

\u2022 Optional center: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#scrollable","title":"scrollable","text":"

\u2022 Optional scrollable: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#value","title":"value","text":"

\u2022 Optional value: D

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#inherited-from_1","title":"Inherited from","text":"

TabsContextValue.value

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#withborder","title":"withBorder","text":"

\u2022 Optional withBorder: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#inherited-from_2","title":"Inherited from","text":"

TabsContextValue.withBorder

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#wrap","title":"wrap","text":"

\u2022 Optional wrap: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#onchange","title":"onChange","text":"

\u25b8 Optional onChange(value): void

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#parameters","title":"Parameters","text":"Name Type value D"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#inherited-from_3","title":"Inherited from","text":"

TabsContextValue.onChange

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/","title":"Renderer.Component.TooltipContentFormatters","text":"

@k8slens/extensions / Exports / Renderer / Component / TooltipContentFormatters

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#interface-tooltipcontentformatters","title":"Interface: TooltipContentFormatters","text":"

Renderer.Component.TooltipContentFormatters

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#properties","title":"Properties","text":"
  • narrow
  • nowrap
  • small
  • tableView
  • warning
"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#narrow","title":"narrow","text":"

\u2022 Optional narrow: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#nowrap","title":"nowrap","text":"

\u2022 Optional nowrap: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#small","title":"small","text":"

\u2022 Optional small: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#tableview","title":"tableView","text":"

\u2022 Optional tableView: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#warning","title":"warning","text":"

\u2022 Optional warning: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/","title":"Renderer.Component.TooltipDecoratorProps","text":"

@k8slens/extensions / Exports / Renderer / Component / TooltipDecoratorProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#interface-tooltipdecoratorprops","title":"Interface: TooltipDecoratorProps","text":"

Renderer.Component.TooltipDecoratorProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#properties","title":"Properties","text":"
  • children
  • id
  • tooltip
  • tooltipOverrideDisabled
"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#children","title":"children","text":"

\u2022 Optional children: SingleOrMany<ReactNode>

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#id","title":"id","text":"

\u2022 Optional id: string

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#tooltip","title":"tooltip","text":"

\u2022 Optional tooltip: ReactNode | Omit<TooltipProps, \"targetId\">

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#tooltipoverridedisabled","title":"tooltipOverrideDisabled","text":"

\u2022 Optional tooltipOverrideDisabled: boolean

forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is \"disabled\"

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/","title":"Renderer.Component.TooltipProps","text":"

@k8slens/extensions / Exports / Renderer / Component / TooltipProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#interface-tooltipprops","title":"Interface: TooltipProps","text":"

Renderer.Component.TooltipProps

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#properties","title":"Properties","text":"
  • children
  • className
  • data-testid
  • formatters
  • offset
  • preferredPositions
  • style
  • targetId
  • tooltipOnParentHover
  • usePortal
  • visible
"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#children","title":"children","text":"

\u2022 Optional children: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#classname","title":"className","text":"

\u2022 Optional className: IClassName

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#data-testid","title":"data-testid","text":"

\u2022 Optional data-testid: string

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#formatters","title":"formatters","text":"

\u2022 Optional formatters: TooltipContentFormatters

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#offset","title":"offset","text":"

\u2022 Optional offset: number

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#preferredpositions","title":"preferredPositions","text":"

\u2022 Optional preferredPositions: TooltipPosition | TooltipPosition[]

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#style","title":"style","text":"

\u2022 Optional style: CSSProperties

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#targetid","title":"targetId","text":"

\u2022 targetId: string

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#tooltiponparenthover","title":"tooltipOnParentHover","text":"

\u2022 Optional tooltipOnParentHover: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#useportal","title":"usePortal","text":"

\u2022 Optional usePortal: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#visible","title":"visible","text":"

\u2022 Optional visible: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/","title":"Renderer.Component.WizardCommonProps","text":"

@k8slens/extensions / Exports / Renderer / Component / WizardCommonProps

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#interface-wizardcommonpropsd","title":"Interface: WizardCommonProps<D>","text":"

Renderer.Component.WizardCommonProps

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#type-parameters","title":"Type parameters","text":"Name D"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#hierarchy","title":"Hierarchy","text":"
  • WizardCommonProps

\u21b3 WizardProps

\u21b3 WizardStepProps

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#properties","title":"Properties","text":"
  • data
  • done
  • hideSteps
  • reset
  • save
"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#data","title":"data","text":"

\u2022 Optional data: Partial<D>

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#done","title":"done","text":"

\u2022 Optional done: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#type-declaration","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#hidesteps","title":"hideSteps","text":"

\u2022 Optional hideSteps: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#reset","title":"reset","text":"

\u2022 Optional reset: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#save","title":"save","text":"

\u2022 Optional save: (data: Partial<D>, callback?: () => void) => void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (data, callback?): void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#parameters","title":"Parameters","text":"Name Type data Partial<D> callback? () => void"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/","title":"Renderer.Component.WizardLayoutProps","text":"

@k8slens/extensions / Exports / Renderer / Component / WizardLayoutProps

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#interface-wizardlayoutprops","title":"Interface: WizardLayoutProps","text":"

Renderer.Component.WizardLayoutProps

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#hierarchy","title":"Hierarchy","text":"
  • DOMAttributes<any>

\u21b3 WizardLayoutProps

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#properties","title":"Properties","text":"
  • centered
  • className
  • contentClass
  • header
  • headerClass
  • infoPanel
  • infoPanelClass
"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#centered","title":"centered","text":"

\u2022 Optional centered: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#classname","title":"className","text":"

\u2022 Optional className: IClassName

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#contentclass","title":"contentClass","text":"

\u2022 Optional contentClass: IClassName

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#header","title":"header","text":"

\u2022 Optional header: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#headerclass","title":"headerClass","text":"

\u2022 Optional headerClass: IClassName

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#infopanel","title":"infoPanel","text":"

\u2022 Optional infoPanel: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#infopanelclass","title":"infoPanelClass","text":"

\u2022 Optional infoPanelClass: IClassName

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/","title":"Renderer.Component.WizardProps","text":"

@k8slens/extensions / Exports / Renderer / Component / WizardProps

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#interface-wizardpropsd","title":"Interface: WizardProps<D>","text":"

Renderer.Component.WizardProps

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#type-parameters","title":"Type parameters","text":"Name D"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#hierarchy","title":"Hierarchy","text":"
  • WizardCommonProps<D>

\u21b3 WizardProps

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#properties","title":"Properties","text":"
  • children
  • className
  • data
  • done
  • header
  • hideSteps
  • onChange
  • reset
  • save
  • step
  • title
"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#children","title":"children","text":"

\u2022 Optional children: ReactElement<WizardStepProps<D>, string | JSXElementConstructor<any>> | ReactElement<WizardStepProps<D>, string | JSXElementConstructor<any>>[]

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#classname","title":"className","text":"

\u2022 Optional className: string

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#data","title":"data","text":"

\u2022 Optional data: Partial<D>

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#inherited-from","title":"Inherited from","text":"

WizardCommonProps.data

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#done","title":"done","text":"

\u2022 Optional done: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#type-declaration","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#inherited-from_1","title":"Inherited from","text":"

WizardCommonProps.done

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#header","title":"header","text":"

\u2022 Optional header: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#hidesteps","title":"hideSteps","text":"

\u2022 Optional hideSteps: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#inherited-from_2","title":"Inherited from","text":"

WizardCommonProps.hideSteps

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#onchange","title":"onChange","text":"

\u2022 Optional onChange: (step: number) => void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (step): void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#parameters","title":"Parameters","text":"Name Type step number"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#reset","title":"reset","text":"

\u2022 Optional reset: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#inherited-from_3","title":"Inherited from","text":"

WizardCommonProps.reset

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#save","title":"save","text":"

\u2022 Optional save: (data: Partial<D>, callback?: () => void) => void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (data, callback?): void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#parameters_1","title":"Parameters","text":"Name Type data Partial<D> callback? () => void"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#inherited-from_4","title":"Inherited from","text":"

WizardCommonProps.save

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#step","title":"step","text":"

\u2022 Optional step: number

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#title","title":"title","text":"

\u2022 Optional title: string

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/","title":"Renderer.Component.WizardStepProps","text":"

@k8slens/extensions / Exports / Renderer / Component / WizardStepProps

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#interface-wizardsteppropsd","title":"Interface: WizardStepProps<D>","text":"

Renderer.Component.WizardStepProps

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#type-parameters","title":"Type parameters","text":"Name D"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#hierarchy","title":"Hierarchy","text":"
  • WizardCommonProps<D>

\u21b3 WizardStepProps

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#properties","title":"Properties","text":"
  • afterContent
  • beforeContent
  • children
  • className
  • contentClass
  • customButtons
  • data
  • disabledNext
  • done
  • first
  • hideBackBtn
  • hideNextBtn
  • hideSteps
  • isFirst
  • isLast
  • last
  • loading
  • moreButtons
  • next
  • nextLabel
  • noValidate
  • prev
  • prevLabel
  • reset
  • save
  • scrollable
  • skip
  • step
  • testIdForNext
  • testIdForPrev
  • title
  • waiting
  • wizard
"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#aftercontent","title":"afterContent","text":"

\u2022 Optional afterContent: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#beforecontent","title":"beforeContent","text":"

\u2022 Optional beforeContent: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#children","title":"children","text":"

\u2022 Optional children: ReactNode | ReactNode[]

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#classname","title":"className","text":"

\u2022 Optional className: string | object

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#contentclass","title":"contentClass","text":"

\u2022 Optional contentClass: string | object

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#custombuttons","title":"customButtons","text":"

\u2022 Optional customButtons: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#data","title":"data","text":"

\u2022 Optional data: Partial<D>

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#inherited-from","title":"Inherited from","text":"

WizardCommonProps.data

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#disablednext","title":"disabledNext","text":"

\u2022 Optional disabledNext: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#done","title":"done","text":"

\u2022 Optional done: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#type-declaration","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#inherited-from_1","title":"Inherited from","text":"

WizardCommonProps.done

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#first","title":"first","text":"

\u2022 Optional first: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#returns_1","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#hidebackbtn","title":"hideBackBtn","text":"

\u2022 Optional hideBackBtn: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#hidenextbtn","title":"hideNextBtn","text":"

\u2022 Optional hideNextBtn: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#hidesteps","title":"hideSteps","text":"

\u2022 Optional hideSteps: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#inherited-from_2","title":"Inherited from","text":"

WizardCommonProps.hideSteps

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#isfirst","title":"isFirst","text":"

\u2022 Optional isFirst: () => boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (): boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#returns_2","title":"Returns","text":"

boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#islast","title":"isLast","text":"

\u2022 Optional isLast: () => boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (): boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#returns_3","title":"Returns","text":"

boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#last","title":"last","text":"

\u2022 Optional last: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#returns_4","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#loading","title":"loading","text":"

\u2022 Optional loading: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#morebuttons","title":"moreButtons","text":"

\u2022 Optional moreButtons: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#next","title":"next","text":"

\u2022 Optional next: () => boolean | void | Promise<any>

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#type-declaration_5","title":"Type declaration","text":"

\u25b8 (): boolean | void | Promise<any>

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#returns_5","title":"Returns","text":"

boolean | void | Promise<any>

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#nextlabel","title":"nextLabel","text":"

\u2022 Optional nextLabel: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#novalidate","title":"noValidate","text":"

\u2022 Optional noValidate: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#prev","title":"prev","text":"

\u2022 Optional prev: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#type-declaration_6","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#returns_6","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#prevlabel","title":"prevLabel","text":"

\u2022 Optional prevLabel: ReactNode

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#reset","title":"reset","text":"

\u2022 Optional reset: () => void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#type-declaration_7","title":"Type declaration","text":"

\u25b8 (): void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#returns_7","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#inherited-from_3","title":"Inherited from","text":"

WizardCommonProps.reset

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#save","title":"save","text":"

\u2022 Optional save: (data: Partial<D>, callback?: () => void) => void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#type-declaration_8","title":"Type declaration","text":"

\u25b8 (data, callback?): void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#parameters","title":"Parameters","text":"Name Type data Partial<D> callback? () => void"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#returns_8","title":"Returns","text":"

void

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#inherited-from_4","title":"Inherited from","text":"

WizardCommonProps.save

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#scrollable","title":"scrollable","text":"

\u2022 Optional scrollable: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#skip","title":"skip","text":"

\u2022 Optional skip: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#step","title":"step","text":"

\u2022 Optional step: number

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#testidfornext","title":"testIdForNext","text":"

\u2022 Optional testIdForNext: string

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#testidforprev","title":"testIdForPrev","text":"

\u2022 Optional testIdForPrev: string

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#title","title":"title","text":"

\u2022 Optional title: string

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#waiting","title":"waiting","text":"

\u2022 Optional waiting: boolean

"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#wizard","title":"wizard","text":"

\u2022 Optional wizard: Wizard<D>

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/","title":"Renderer.K8sApi.KubeObjectStatus","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / KubeObjectStatus

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#interface-kubeobjectstatus","title":"Interface: KubeObjectStatus","text":"

Renderer.K8sApi.KubeObjectStatus

Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#properties","title":"Properties","text":"
  • level
  • text
  • timestamp
"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#level","title":"level","text":"

\u2022 level: KubeObjectStatusLevel

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#text","title":"text","text":"

\u2022 text: string

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#timestamp","title":"timestamp","text":"

\u2022 Optional timestamp: string

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricData/","title":"Renderer.K8sApi.MetricData","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / MetricData

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricData/#interface-metricdata","title":"Interface: MetricData","text":"

Renderer.K8sApi.MetricData

Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricData/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricData/#properties","title":"Properties","text":"
  • data
  • status
"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricData/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricData/#data","title":"data","text":"

\u2022 data: Object

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricData/#type-declaration","title":"Type declaration","text":"Name Type result MetricResult[] resultType string"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricData/#status","title":"status","text":"

\u2022 status: string

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricResult/","title":"Renderer.K8sApi.MetricResult","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / MetricResult

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricResult/#interface-metricresult","title":"Interface: MetricResult","text":"

Renderer.K8sApi.MetricResult

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricResult/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricResult/#properties","title":"Properties","text":"
  • metric
  • values
"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricResult/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricResult/#metric","title":"metric","text":"

\u2022 metric: Object

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricResult/#index-signature","title":"Index signature","text":"

\u25aa [name: string]: string | undefined

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricResult/#type-declaration","title":"Type declaration","text":"Name Type instance? string kubernetes? string kubernetes_namespace? string kubernetes_node? string node? string pod? string"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricResult/#values","title":"values","text":"

\u2022 values: [number, string][]

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/","title":"Renderer.K8sApi.RequestMetricsParams","text":"

@k8slens/extensions / Exports / Renderer / K8sApi / RequestMetricsParams

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#interface-requestmetricsparams","title":"Interface: RequestMetricsParams","text":"

Renderer.K8sApi.RequestMetricsParams

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#properties","title":"Properties","text":"
  • end
  • namespace
  • range
  • start
  • step
"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#end","title":"end","text":"

\u2022 Optional end: string | number

timestamp in seconds or valid date-string

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#namespace","title":"namespace","text":"

\u2022 Optional namespace: string

rbac-proxy validation param

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#range","title":"range","text":"

\u2022 Optional range: number

time-range in seconds for data aggregation

Default

3600 (1 hour)\n
"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#start","title":"start","text":"

\u2022 Optional start: string | number

timestamp in seconds or valid date-string

"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#step","title":"step","text":"

\u2022 Optional step: number

step in seconds

Default

60 (1 minute)\n
"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/","title":"Renderer.Navigation.PageParamInit","text":"

@k8slens/extensions / Exports / Renderer / Navigation / PageParamInit

"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#interface-pageparaminitvalue","title":"Interface: PageParamInit<Value>","text":"

Renderer.Navigation.PageParamInit

"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#type-parameters","title":"Type parameters","text":"Name Type Value any"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#properties","title":"Properties","text":"
  • defaultValue
  • name
"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#methods","title":"Methods","text":"
  • parse
  • stringify
"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#defaultvalue","title":"defaultValue","text":"

\u2022 Optional defaultValue: Value

"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#name","title":"name","text":"

\u2022 name: string

"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#parse","title":"parse","text":"

\u25b8 Optional parse(value): Value

"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#parameters","title":"Parameters","text":"Name Type value string | string[]"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#returns","title":"Returns","text":"

Value

"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#stringify","title":"stringify","text":"

\u25b8 Optional stringify(value): string | string[]

"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#parameters_1","title":"Parameters","text":"Name Type value Value"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#returns_1","title":"Returns","text":"

string | string[]

"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/","title":"Renderer.Navigation.URLParams","text":"

@k8slens/extensions / Exports / Renderer / Navigation / URLParams

"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#interface-urlparamsp-q","title":"Interface: URLParams<P, Q>","text":"

Renderer.Navigation.URLParams

"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#type-parameters","title":"Type parameters","text":"Name Type P extends object = {} Q extends object = {}"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#properties","title":"Properties","text":"
  • fragment
  • params
  • query
"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#fragment","title":"fragment","text":"

\u2022 Optional fragment: string

"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#params","title":"params","text":"

\u2022 Optional params: P

"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#query","title":"query","text":"

\u2022 Optional query: Q

"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/","title":"Renderer.Theme.LensTheme","text":"

@k8slens/extensions / Exports / Renderer / Theme / LensTheme

"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#interface-lenstheme","title":"Interface: LensTheme","text":"

Renderer.Theme.LensTheme

"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#properties","title":"Properties","text":"
  • author
  • colors
  • description
  • isDefault
  • monacoTheme
  • name
  • terminalColors
  • type
"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#properties_1","title":"Properties","text":""},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#author","title":"author","text":"

\u2022 author: string

"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#colors","title":"colors","text":"

\u2022 colors: Record<LensColorName, string>

"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#description","title":"description","text":"

\u2022 description: string

"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#isdefault","title":"isDefault","text":"

\u2022 Optional isDefault: boolean

"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#monacotheme","title":"monacoTheme","text":"

\u2022 monacoTheme: MonacoTheme

"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#name","title":"name","text":"

\u2022 name: string

"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#terminalcolors","title":"terminalColors","text":"

\u2022 terminalColors: Partial<Record<TerminalColorName, string>>

"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#type","title":"type","text":"

\u2022 type: LensThemeType

"},{"location":"extensions/api/modules/Common.Catalog/","title":"Common.Catalog","text":"

@k8slens/extensions / Exports / Common / Catalog

"},{"location":"extensions/api/modules/Common.Catalog/#namespace-catalog","title":"Namespace: Catalog","text":"

Common.Catalog

"},{"location":"extensions/api/modules/Common.Catalog/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Common.Catalog/#classes","title":"Classes","text":"
  • CatalogCategory
  • CatalogEntity
  • GeneralEntity
  • KubernetesCluster
  • KubernetesClusterCategory
  • WebLink
"},{"location":"extensions/api/modules/Common.Catalog/#interfaces","title":"Interfaces","text":"
  • CatalogCategoryEvents
  • CatalogCategoryMetadata
  • CatalogCategorySpec
  • CatalogCategoryVersion
  • CatalogEntityActionContext
  • CatalogEntityAddMenu
  • CatalogEntityAddMenuContext
  • CatalogEntityContextMenu
  • CatalogEntityContextMenuContext
  • CatalogEntityContextMenuNavigate
  • CatalogEntityData
  • CatalogEntityKindData
  • CatalogEntityMetadata
  • CatalogEntitySettingsContext
  • CatalogEntitySettingsMenu
  • CatalogEntityStatus
  • CategoryColumnRegistration
  • GeneralEntitySpec
  • KubernetesClusterMetadata
  • KubernetesClusterPrometheusMetrics
  • KubernetesClusterSpec
  • KubernetesClusterStatus
  • TitleCellProps
  • WebLinkSpec
  • WebLinkStatus
"},{"location":"extensions/api/modules/Common.Catalog/#type-aliases","title":"Type Aliases","text":"
  • AddMenuFilter
  • CatalogEntityConstructor
  • CatalogEntityDataFor
  • CatalogEntityInstanceFrom
  • CatalogEntitySpec
  • EntityMetadataObject
  • EntityMetadataValue
  • KubernetesClusterStatusPhase
  • WebLinkStatusPhase
"},{"location":"extensions/api/modules/Common.Catalog/#variables","title":"Variables","text":"
  • kubernetesClusterCategory
"},{"location":"extensions/api/modules/Common.Catalog/#functions","title":"Functions","text":"
  • categoryVersion
"},{"location":"extensions/api/modules/Common.Catalog/#type-aliases_1","title":"Type Aliases","text":""},{"location":"extensions/api/modules/Common.Catalog/#addmenufilter","title":"AddMenuFilter","text":"

\u01ac AddMenuFilter: (menu: CatalogEntityAddMenu) => any

"},{"location":"extensions/api/modules/Common.Catalog/#type-declaration","title":"Type declaration","text":"

\u25b8 (menu): any

If the filter return a thruthy value, the menu item is displayed

"},{"location":"extensions/api/modules/Common.Catalog/#parameters","title":"Parameters","text":"Name Type menu CatalogEntityAddMenu"},{"location":"extensions/api/modules/Common.Catalog/#returns","title":"Returns","text":"

any

"},{"location":"extensions/api/modules/Common.Catalog/#catalogentityconstructor","title":"CatalogEntityConstructor","text":"

\u01ac CatalogEntityConstructor<Entity>: (data: CatalogEntityDataFor<Entity>) => Entity

"},{"location":"extensions/api/modules/Common.Catalog/#type-parameters","title":"Type parameters","text":"Name Type Entity extends CatalogEntity"},{"location":"extensions/api/modules/Common.Catalog/#type-declaration_1","title":"Type declaration","text":"

\u2022 (data)

"},{"location":"extensions/api/modules/Common.Catalog/#parameters_1","title":"Parameters","text":"Name Type data CatalogEntityDataFor<Entity>"},{"location":"extensions/api/modules/Common.Catalog/#catalogentitydatafor","title":"CatalogEntityDataFor","text":"

\u01ac CatalogEntityDataFor<Entity>: Entity extends CatalogEntity<infer Metadata, infer Status, infer Spec> ? CatalogEntityData<Metadata, Status, Spec> : never

"},{"location":"extensions/api/modules/Common.Catalog/#type-parameters_1","title":"Type parameters","text":"Name Entity"},{"location":"extensions/api/modules/Common.Catalog/#catalogentityinstancefrom","title":"CatalogEntityInstanceFrom","text":"

\u01ac CatalogEntityInstanceFrom<Constructor>: Constructor extends CatalogEntityConstructor<infer Entity> ? Entity : never

"},{"location":"extensions/api/modules/Common.Catalog/#type-parameters_2","title":"Type parameters","text":"Name Constructor"},{"location":"extensions/api/modules/Common.Catalog/#catalogentityspec","title":"CatalogEntitySpec","text":"

\u01ac CatalogEntitySpec: Record<string, any>

"},{"location":"extensions/api/modules/Common.Catalog/#entitymetadataobject","title":"EntityMetadataObject","text":"

\u01ac EntityMetadataObject: { [Key in string]?: EntityMetadataValue }

"},{"location":"extensions/api/modules/Common.Catalog/#entitymetadatavalue","title":"EntityMetadataValue","text":"

\u01ac EntityMetadataValue: string | number | boolean | EntityMetadataObject | undefined

"},{"location":"extensions/api/modules/Common.Catalog/#kubernetesclusterstatusphase","title":"KubernetesClusterStatusPhase","text":"

\u01ac KubernetesClusterStatusPhase: \"connected\" | \"connecting\" | \"disconnected\" | \"deleting\"

Deprecated

This is no longer used as it is incorrect. Other sources can add more values

"},{"location":"extensions/api/modules/Common.Catalog/#weblinkstatusphase","title":"WebLinkStatusPhase","text":"

\u01ac WebLinkStatusPhase: \"available\" | \"unavailable\"

"},{"location":"extensions/api/modules/Common.Catalog/#variables_1","title":"Variables","text":""},{"location":"extensions/api/modules/Common.Catalog/#kubernetesclustercategory","title":"kubernetesClusterCategory","text":"

\u2022 Const kubernetesClusterCategory: KubernetesClusterCategory

"},{"location":"extensions/api/modules/Common.Catalog/#functions_1","title":"Functions","text":""},{"location":"extensions/api/modules/Common.Catalog/#categoryversion","title":"categoryVersion","text":"

\u25b8 categoryVersion<T, Metadata, Status, Spec>(name, entityClass): CatalogCategoryVersion

"},{"location":"extensions/api/modules/Common.Catalog/#type-parameters_3","title":"Type parameters","text":"Name Type T extends CatalogEntity<Metadata, Status, Spec, T> Metadata extends CatalogEntityMetadata<Metadata> Status extends CatalogEntityStatus Spec extends CatalogEntitySpec"},{"location":"extensions/api/modules/Common.Catalog/#parameters_2","title":"Parameters","text":"Name Type name string entityClass (data: CatalogEntityData<Metadata, Status, Spec>) => T"},{"location":"extensions/api/modules/Common.Catalog/#returns_1","title":"Returns","text":"

CatalogCategoryVersion

"},{"location":"extensions/api/modules/Common.EventBus/","title":"Common.EventBus","text":"

@k8slens/extensions / Exports / Common / EventBus

"},{"location":"extensions/api/modules/Common.EventBus/#namespace-eventbus","title":"Namespace: EventBus","text":"

Common.EventBus

"},{"location":"extensions/api/modules/Common.EventBus/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Common.EventBus/#classes","title":"Classes","text":"
  • EventEmitter
"},{"location":"extensions/api/modules/Common.EventBus/#interfaces","title":"Interfaces","text":"
  • AppEvent
  • EventEmitterOptions
"},{"location":"extensions/api/modules/Common.EventBus/#type-aliases","title":"Type Aliases","text":"
  • EventEmitterCallback
"},{"location":"extensions/api/modules/Common.EventBus/#variables","title":"Variables","text":"
  • appEventBus
"},{"location":"extensions/api/modules/Common.EventBus/#type-aliases_1","title":"Type Aliases","text":""},{"location":"extensions/api/modules/Common.EventBus/#eventemittercallback","title":"EventEmitterCallback","text":"

\u01ac EventEmitterCallback<D>: (...data: D) => void | boolean

"},{"location":"extensions/api/modules/Common.EventBus/#type-parameters","title":"Type parameters","text":"Name Type D extends any[]"},{"location":"extensions/api/modules/Common.EventBus/#type-declaration","title":"Type declaration","text":"

\u25b8 (...data): void | boolean

"},{"location":"extensions/api/modules/Common.EventBus/#parameters","title":"Parameters","text":"Name Type ...data D"},{"location":"extensions/api/modules/Common.EventBus/#returns","title":"Returns","text":"

void | boolean

"},{"location":"extensions/api/modules/Common.EventBus/#variables_1","title":"Variables","text":""},{"location":"extensions/api/modules/Common.EventBus/#appeventbus","title":"appEventBus","text":"

\u2022 Const appEventBus: EventEmitter<[AppEvent]>

"},{"location":"extensions/api/modules/Common.Proxy/","title":"Common.Proxy","text":"

@k8slens/extensions / Exports / Common / Proxy

"},{"location":"extensions/api/modules/Common.Proxy/#namespace-proxy","title":"Namespace: Proxy","text":"

Common.Proxy

"},{"location":"extensions/api/modules/Common.Proxy/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Common.Proxy/#functions","title":"Functions","text":"
  • resolveSystemProxy
"},{"location":"extensions/api/modules/Common.Proxy/#functions_1","title":"Functions","text":""},{"location":"extensions/api/modules/Common.Proxy/#resolvesystemproxy","title":"resolveSystemProxy","text":"

\u25b8 resolveSystemProxy(url): Promise<string>

Resolves URL-specific proxy information from system. See more here: https://www.electronjs.org/docs/latest/api/session#sesresolveproxyurl

"},{"location":"extensions/api/modules/Common.Proxy/#parameters","title":"Parameters","text":"Name Type Description url string The URL for proxy information"},{"location":"extensions/api/modules/Common.Proxy/#returns","title":"Returns","text":"

Promise<string>

Promise for proxy information as string

"},{"location":"extensions/api/modules/Common.Store/","title":"Common.Store","text":"

@k8slens/extensions / Exports / Common / Store

"},{"location":"extensions/api/modules/Common.Store/#namespace-store","title":"Namespace: Store","text":"

Common.Store

"},{"location":"extensions/api/modules/Common.Store/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Common.Store/#classes","title":"Classes","text":"
  • ExtensionStore
"},{"location":"extensions/api/modules/Common.Store/#interfaces","title":"Interfaces","text":"
  • ExtensionStoreParams
  • PersistentStorageParams
"},{"location":"extensions/api/modules/Common.Types/","title":"Common.Types","text":"

@k8slens/extensions / Exports / Common / Types

"},{"location":"extensions/api/modules/Common.Types/#namespace-types","title":"Namespace: Types","text":"

Common.Types

"},{"location":"extensions/api/modules/Common.Types/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Common.Types/#interfaces","title":"Interfaces","text":"
  • AppPreferenceComponents
  • AppPreferenceRegistration
  • ClusterPageMenuComponents
  • ClusterPageMenuRegistration
  • CustomCategoryViewComponents
  • CustomCategoryViewProps
  • CustomCategoryViewRegistration
  • KubeObjectContextMenuItem
  • KubeObjectDetailComponents
  • KubeObjectDetailRegistration
  • KubeObjectHandlers
  • KubeObjectMenuComponents
  • KubeObjectMenuRegistration
  • KubeObjectOnContextMenuOpenContext
  • KubeObjectStatusRegistration
  • PageComponentProps
  • PageComponents
  • PageParams
  • PageRegistration
  • PageTarget
  • ProtocolHandlerRegistration
  • ProtocolRouteHandler
  • ProtocolRouteParams
  • RegisteredPage
  • ShellEnvContext
  • StatusBarRegistration
  • TrayMenuRegistration
"},{"location":"extensions/api/modules/Common.Types/#type-aliases","title":"Type Aliases","text":"
  • IpcMainEvent
  • IpcMainInvokeEvent
  • IpcRendererEvent
  • KubeObjectHandlerRegistration
  • KubeObjectOnContextMenuOpen
  • MenuRegistration
  • ShellEnvModifier
"},{"location":"extensions/api/modules/Common.Types/#type-aliases_1","title":"Type Aliases","text":""},{"location":"extensions/api/modules/Common.Types/#ipcmainevent","title":"IpcMainEvent","text":"

\u01ac IpcMainEvent: Electron.IpcMainEvent

"},{"location":"extensions/api/modules/Common.Types/#ipcmaininvokeevent","title":"IpcMainInvokeEvent","text":"

\u01ac IpcMainInvokeEvent: Electron.IpcMainInvokeEvent

Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.

"},{"location":"extensions/api/modules/Common.Types/#ipcrendererevent","title":"IpcRendererEvent","text":"

\u01ac IpcRendererEvent: Electron.IpcRendererEvent

"},{"location":"extensions/api/modules/Common.Types/#kubeobjecthandlerregistration","title":"KubeObjectHandlerRegistration","text":"

\u01ac KubeObjectHandlerRegistration: { apiVersions: string[] ; kind: string } & RequireAtLeastOne<KubeObjectHandlers>

"},{"location":"extensions/api/modules/Common.Types/#kubeobjectoncontextmenuopen","title":"KubeObjectOnContextMenuOpen","text":"

\u01ac KubeObjectOnContextMenuOpen: (ctx: KubeObjectOnContextMenuOpenContext) => void

"},{"location":"extensions/api/modules/Common.Types/#type-declaration","title":"Type declaration","text":"

\u25b8 (ctx): void

"},{"location":"extensions/api/modules/Common.Types/#parameters","title":"Parameters","text":"Name Type ctx KubeObjectOnContextMenuOpenContext"},{"location":"extensions/api/modules/Common.Types/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/modules/Common.Types/#menuregistration","title":"MenuRegistration","text":"

\u01ac MenuRegistration: { parentId: string ; visible?: IComputedValue<boolean> | boolean } & Omit<MenuItemConstructorOptions, \"visible\">

"},{"location":"extensions/api/modules/Common.Types/#shellenvmodifier","title":"ShellEnvModifier","text":"

\u01ac ShellEnvModifier: (ctx: ShellEnvContext, env: Record<string, string | undefined>) => Record<string, string | undefined>

"},{"location":"extensions/api/modules/Common.Types/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (ctx, env): Record<string, string | undefined>

"},{"location":"extensions/api/modules/Common.Types/#parameters_1","title":"Parameters","text":"Name Type ctx ShellEnvContext env Record<string, string | undefined>"},{"location":"extensions/api/modules/Common.Types/#returns_1","title":"Returns","text":"

Record<string, string | undefined>

"},{"location":"extensions/api/modules/Common.Util/","title":"Common.Util","text":"

@k8slens/extensions / Exports / Common / Util

"},{"location":"extensions/api/modules/Common.Util/#namespace-util","title":"Namespace: Util","text":"

Common.Util

"},{"location":"extensions/api/modules/Common.Util/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Common.Util/#classes","title":"Classes","text":"
  • Singleton
"},{"location":"extensions/api/modules/Common.Util/#interfaces","title":"Interfaces","text":"
  • Disposable
  • Disposer
  • ExtendableDisposer
"},{"location":"extensions/api/modules/Common.Util/#type-aliases","title":"Type Aliases","text":"
  • IClassName
  • IgnoredClassNames
  • OpenLinkInBrowser
"},{"location":"extensions/api/modules/Common.Util/#functions","title":"Functions","text":"
  • cssNames
  • disposer
  • getAppVersion
  • openBrowser
  • openExternal
  • prevDefault
  • stopPropagation
"},{"location":"extensions/api/modules/Common.Util/#type-aliases_1","title":"Type Aliases","text":""},{"location":"extensions/api/modules/Common.Util/#iclassname","title":"IClassName","text":"

\u01ac IClassName: string | string[] | Record<string, any> | undefined | null | false | IgnoredClassNames

"},{"location":"extensions/api/modules/Common.Util/#ignoredclassnames","title":"IgnoredClassNames","text":"

\u01ac IgnoredClassNames: number | symbol | Function

Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.

"},{"location":"extensions/api/modules/Common.Util/#openlinkinbrowser","title":"OpenLinkInBrowser","text":"

\u01ac OpenLinkInBrowser: (url: string) => Promise<void>

"},{"location":"extensions/api/modules/Common.Util/#type-declaration","title":"Type declaration","text":"

\u25b8 (url): Promise<void>

"},{"location":"extensions/api/modules/Common.Util/#parameters","title":"Parameters","text":"Name Type url string"},{"location":"extensions/api/modules/Common.Util/#returns","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/modules/Common.Util/#functions_1","title":"Functions","text":""},{"location":"extensions/api/modules/Common.Util/#cssnames","title":"cssNames","text":"

\u25b8 cssNames(...classNames): string

"},{"location":"extensions/api/modules/Common.Util/#parameters_1","title":"Parameters","text":"Name Type ...classNames IClassName[]"},{"location":"extensions/api/modules/Common.Util/#returns_1","title":"Returns","text":"

string

"},{"location":"extensions/api/modules/Common.Util/#disposer","title":"disposer","text":"

\u25b8 disposer(...items): ExtendableDisposer

"},{"location":"extensions/api/modules/Common.Util/#parameters_2","title":"Parameters","text":"Name Type ...items SingleOrMany<undefined | null | Disposer | Disposable>[]"},{"location":"extensions/api/modules/Common.Util/#returns_2","title":"Returns","text":"

ExtendableDisposer

"},{"location":"extensions/api/modules/Common.Util/#getappversion","title":"getAppVersion","text":"

\u25b8 getAppVersion(): string

"},{"location":"extensions/api/modules/Common.Util/#returns_3","title":"Returns","text":"

string

"},{"location":"extensions/api/modules/Common.Util/#openbrowser","title":"openBrowser","text":"

\u25b8 openBrowser(url): Promise<void>

"},{"location":"extensions/api/modules/Common.Util/#parameters_3","title":"Parameters","text":"Name Type url string"},{"location":"extensions/api/modules/Common.Util/#returns_4","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/modules/Common.Util/#openexternal","title":"openExternal","text":"

\u25b8 openExternal(url): Promise<void>

"},{"location":"extensions/api/modules/Common.Util/#parameters_4","title":"Parameters","text":"Name Type url string"},{"location":"extensions/api/modules/Common.Util/#returns_5","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/modules/Common.Util/#prevdefault","title":"prevDefault","text":"

\u25b8 prevDefault<E, R>(callback): (event: E) => R

"},{"location":"extensions/api/modules/Common.Util/#type-parameters","title":"Type parameters","text":"Name Type E extends Event | SyntheticEvent<Element, Event> R R"},{"location":"extensions/api/modules/Common.Util/#parameters_5","title":"Parameters","text":"Name Type callback (evt: E) => R"},{"location":"extensions/api/modules/Common.Util/#returns_6","title":"Returns","text":"

fn

\u25b8 (event): R

"},{"location":"extensions/api/modules/Common.Util/#parameters_6","title":"Parameters","text":"Name Type event E"},{"location":"extensions/api/modules/Common.Util/#returns_7","title":"Returns","text":"

R

"},{"location":"extensions/api/modules/Common.Util/#stoppropagation","title":"stopPropagation","text":"

\u25b8 stopPropagation(evt): void

"},{"location":"extensions/api/modules/Common.Util/#parameters_7","title":"Parameters","text":"Name Type evt Event | SyntheticEvent<Element, Event>"},{"location":"extensions/api/modules/Common.Util/#returns_8","title":"Returns","text":"

void

"},{"location":"extensions/api/modules/Common/","title":"Common","text":"

@k8slens/extensions / Exports / Common

"},{"location":"extensions/api/modules/Common/#namespace-common","title":"Namespace: Common","text":"

Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.

"},{"location":"extensions/api/modules/Common/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Common/#namespaces","title":"Namespaces","text":"
  • Catalog
  • EventBus
  • Proxy
  • Store
  • Types
  • Util
"},{"location":"extensions/api/modules/Common/#classes","title":"Classes","text":"
  • LensExtension
"},{"location":"extensions/api/modules/Common/#interfaces","title":"Interfaces","text":"
  • LensExtensionManifest
  • Logger
"},{"location":"extensions/api/modules/Common/#type-aliases","title":"Type Aliases","text":"
  • InstalledExtension
"},{"location":"extensions/api/modules/Common/#variables","title":"Variables","text":"
  • App
  • logger
"},{"location":"extensions/api/modules/Common/#type-aliases_1","title":"Type Aliases","text":""},{"location":"extensions/api/modules/Common/#installedextension","title":"InstalledExtension","text":"

\u01ac InstalledExtension: BundledInstalledExtension | ExternalInstalledExtension

"},{"location":"extensions/api/modules/Common/#variables_1","title":"Variables","text":""},{"location":"extensions/api/modules/Common/#app","title":"App","text":"

\u2022 Const App: Object

Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.

"},{"location":"extensions/api/modules/Common/#type-declaration","title":"Type declaration","text":"Name Type Description Preferences { getKubectlPath: () => string | undefined } - Preferences.getKubectlPath () => string | undefined - appName string - getEnabledExtensions () => string[] - isLinux boolean - isMac boolean - isSnap boolean - isWindows boolean - issuesTrackerUrl string - lensBuildEnvironment string - slackUrl \"\" Deprecated This value is now \"\" and is left here for backwards compatibility. version string -"},{"location":"extensions/api/modules/Common/#logger","title":"logger","text":"

\u2022 Const logger: Logger

"},{"location":"extensions/api/modules/Main.Catalog/","title":"Main.Catalog","text":"

@k8slens/extensions / Exports / Main / Catalog

"},{"location":"extensions/api/modules/Main.Catalog/#namespace-catalog","title":"Namespace: Catalog","text":"

Main.Catalog

Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.

"},{"location":"extensions/api/modules/Main.Catalog/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Main.Catalog/#interfaces","title":"Interfaces","text":"
  • CatalogEntityRegistry
"},{"location":"extensions/api/modules/Main.Catalog/#variables","title":"Variables","text":"
  • catalogCategories
  • catalogEntities
"},{"location":"extensions/api/modules/Main.Catalog/#variables_1","title":"Variables","text":""},{"location":"extensions/api/modules/Main.Catalog/#catalogcategories","title":"catalogCategories","text":"

\u2022 Const catalogCategories: CatalogCategoryRegistry

"},{"location":"extensions/api/modules/Main.Catalog/#catalogentities","title":"catalogEntities","text":"

\u2022 Const catalogEntities: CatalogEntityRegistry

"},{"location":"extensions/api/modules/Main.K8sApi/","title":"Main.K8sApi","text":"

@k8slens/extensions / Exports / Main / K8sApi

"},{"location":"extensions/api/modules/Main.K8sApi/#namespace-k8sapi","title":"Namespace: K8sApi","text":"

Main.K8sApi

"},{"location":"extensions/api/modules/Main.K8sApi/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Main.K8sApi/#references","title":"References","text":"
  • createKubeObject
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isKubeObjectNonSystem
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • stringifyLabels
"},{"location":"extensions/api/modules/Main.K8sApi/#classes","title":"Classes","text":"
  • ClusterRole
  • ClusterRoleBinding
  • ConfigMap
  • CronJob
  • CustomResourceDefinition
  • DaemonSet
  • Deployment
  • Endpoint
  • HorizontalPodAutoscaler
  • Ingress
  • Job
  • KubeEvent
  • KubeObject
  • KubeObjectStore
  • KubeStatus
  • LimitRange
  • Namespace
  • NetworkPolicy
  • Node
  • PersistentVolume
  • PersistentVolumeClaim
  • Pod
  • PodDisruptionBudget
  • PriorityClass
  • ReplicaSet
  • ResourceQuota
  • ResourceStack
  • Role
  • RoleBinding
  • Secret
  • Service
  • ServiceAccount
  • StatefulSet
  • StorageClass
"},{"location":"extensions/api/modules/Main.K8sApi/#interfaces","title":"Interfaces","text":"
  • BaseKubeJsonApiObjectMetadata
  • ExternalKubeApiOptions
  • IKubeApiCluster
  • ILocalKubeApiConfig
  • IPodContainer
  • IPodContainerStatus
  • IRemoteKubeApiConfig
  • ISecretRef
  • IgnoredKubeApiOptions
  • KubeJsonApiData
  • KubeObjectStoreLoadAllParams
  • KubeObjectStoreLoadingParams
  • KubeObjectStoreSubscribeParams
  • KubeStatusData
  • OwnerReference
"},{"location":"extensions/api/modules/Main.K8sApi/#type-aliases","title":"Type Aliases","text":"
  • ClusterScopedMetadata
  • DeploymentApi
  • IngressApi
  • JsonPatch
  • KubeApi
  • KubeJsonApi
  • KubeJsonApiDataFor
  • KubeJsonApiObjectMetadata
  • KubeObjectMetadata
  • NamespaceScopedMetadata
  • NodesApi
  • PersistentVolumeClaimsApi
  • PodsApi
"},{"location":"extensions/api/modules/Main.K8sApi/#variables","title":"Variables","text":"
  • DeploymentApi
  • IngressApi
  • KubeApi
  • KubeJsonApi
  • NodesApi
  • PersistentVolumeClaimsApi
  • PodsApi
  • apiManager
"},{"location":"extensions/api/modules/Main.K8sApi/#functions","title":"Functions","text":"
  • createResourceStack
  • forCluster
  • forRemoteCluster
  • getPodsByOwnerId
  • isAllowedResource
  • isKubeStatusData
"},{"location":"extensions/api/modules/Main.K8sApi/#references_1","title":"References","text":""},{"location":"extensions/api/modules/Main.K8sApi/#createkubeobject","title":"createKubeObject","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Main.K8sApi/#isjsonapidata","title":"isJsonApiData","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Main.K8sApi/#isjsonapidatalist","title":"isJsonApiDataList","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Main.K8sApi/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Main.K8sApi/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Main.K8sApi/#iskubeobjectnonsystem","title":"isKubeObjectNonSystem","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Main.K8sApi/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Main.K8sApi/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Main.K8sApi/#stringifylabels","title":"stringifyLabels","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Main.K8sApi/#type-aliases_1","title":"Type Aliases","text":""},{"location":"extensions/api/modules/Main.K8sApi/#clusterscopedmetadata","title":"ClusterScopedMetadata","text":"

\u01ac ClusterScopedMetadata: KubeObjectMetadata<KubeObjectScope.Cluster>

"},{"location":"extensions/api/modules/Main.K8sApi/#deploymentapi","title":"DeploymentApi","text":"

\u01ac DeploymentApi: InternalDeploymentApi

"},{"location":"extensions/api/modules/Main.K8sApi/#ingressapi","title":"IngressApi","text":"

\u01ac IngressApi: InternalIngressApi

"},{"location":"extensions/api/modules/Main.K8sApi/#jsonpatch","title":"JsonPatch","text":"

\u01ac JsonPatch: Patch

"},{"location":"extensions/api/modules/Main.K8sApi/#kubeapi","title":"KubeApi","text":"

\u01ac KubeApi<Object, Data>: InternalKubeApi<Object, Data>

"},{"location":"extensions/api/modules/Main.K8sApi/#type-parameters","title":"Type parameters","text":"Name Type Object extends KubeObject = KubeObject Data extends KubeJsonApiDataFor<Object> = KubeJsonApiDataFor<Object>"},{"location":"extensions/api/modules/Main.K8sApi/#kubejsonapi","title":"KubeJsonApi","text":"

\u01ac KubeJsonApi: InternalKubeJsonApi

"},{"location":"extensions/api/modules/Main.K8sApi/#kubejsonapidatafor","title":"KubeJsonApiDataFor","text":"

\u01ac KubeJsonApiDataFor<K>: K extends KubeObject<infer Metadata, infer Status, infer Spec> ? KubeJsonApiData<Metadata, Status, Spec> : never

"},{"location":"extensions/api/modules/Main.K8sApi/#type-parameters_1","title":"Type parameters","text":"Name K"},{"location":"extensions/api/modules/Main.K8sApi/#kubejsonapiobjectmetadata","title":"KubeJsonApiObjectMetadata","text":"

\u01ac KubeJsonApiObjectMetadata<Namespaced>: BaseKubeJsonApiObjectMetadata<Namespaced> & Namespaced extends KubeObjectScope.Namespace ? { namespace: string } : {}

"},{"location":"extensions/api/modules/Main.K8sApi/#type-parameters_2","title":"Type parameters","text":"Name Type Namespaced extends KubeObjectScope = KubeObjectScope"},{"location":"extensions/api/modules/Main.K8sApi/#kubeobjectmetadata","title":"KubeObjectMetadata","text":"

\u01ac KubeObjectMetadata<Namespaced>: KubeJsonApiObjectMetadata<Namespaced> & { name: string ; resourceVersion: string ; selfLink: string ; uid: string }

"},{"location":"extensions/api/modules/Main.K8sApi/#type-parameters_3","title":"Type parameters","text":"Name Type Namespaced extends KubeObjectScope = KubeObjectScope"},{"location":"extensions/api/modules/Main.K8sApi/#namespacescopedmetadata","title":"NamespaceScopedMetadata","text":"

\u01ac NamespaceScopedMetadata: KubeObjectMetadata<KubeObjectScope.Namespace>

"},{"location":"extensions/api/modules/Main.K8sApi/#nodesapi","title":"NodesApi","text":"

\u01ac NodesApi: NodeApi

"},{"location":"extensions/api/modules/Main.K8sApi/#persistentvolumeclaimsapi","title":"PersistentVolumeClaimsApi","text":"

\u01ac PersistentVolumeClaimsApi: PersistentVolumeClaimApi

"},{"location":"extensions/api/modules/Main.K8sApi/#podsapi","title":"PodsApi","text":"

\u01ac PodsApi: PodApi

"},{"location":"extensions/api/modules/Main.K8sApi/#variables_1","title":"Variables","text":""},{"location":"extensions/api/modules/Main.K8sApi/#deploymentapi_1","title":"DeploymentApi","text":"

\u2022 DeploymentApi: (opts?: DerivedKubeApiOptions) => DeploymentApi

"},{"location":"extensions/api/modules/Main.K8sApi/#type-declaration","title":"Type declaration","text":"

\u2022 new DeploymentApi(opts?)

"},{"location":"extensions/api/modules/Main.K8sApi/#parameters","title":"Parameters","text":"Name Type opts? DerivedKubeApiOptions"},{"location":"extensions/api/modules/Main.K8sApi/#ingressapi_1","title":"IngressApi","text":"

\u2022 IngressApi: (opts?: DerivedKubeApiOptions & IgnoredKubeApiOptions) => IngressApi

"},{"location":"extensions/api/modules/Main.K8sApi/#type-declaration_1","title":"Type declaration","text":"

\u2022 new IngressApi(opts?)

"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_1","title":"Parameters","text":"Name Type opts? DerivedKubeApiOptions & IgnoredKubeApiOptions"},{"location":"extensions/api/modules/Main.K8sApi/#kubeapi_1","title":"KubeApi","text":"

\u2022 KubeApi: <Object_1, Data>(opts: KubeApiOptions<Object_1, Data> & ExternalKubeApiOptions) => KubeApi<Object_1, Data>

"},{"location":"extensions/api/modules/Main.K8sApi/#type-declaration_2","title":"Type declaration","text":"

\u2022 new KubeApi<Object_1, Data>(opts)

"},{"location":"extensions/api/modules/Main.K8sApi/#type-parameters_4","title":"Type parameters","text":"Name Type Object_1 extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Object_1> = KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> Data extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Data> = KubeJsonApiDataFor<Object_1>"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_2","title":"Parameters","text":"Name Type opts KubeApiOptions<Object_1, Data> & ExternalKubeApiOptions"},{"location":"extensions/api/modules/Main.K8sApi/#kubejsonapi_1","title":"KubeJsonApi","text":"

\u2022 KubeJsonApi: (config: JsonApiConfig, reqInit?: RequestInit) => KubeJsonApi & { forCluster: CreateKubeJsonApiForCluster }

"},{"location":"extensions/api/modules/Main.K8sApi/#nodesapi_1","title":"NodesApi","text":"

\u2022 NodesApi: (opts?: DerivedKubeApiOptions & IgnoredKubeApiOptions) => NodeApi

"},{"location":"extensions/api/modules/Main.K8sApi/#type-declaration_3","title":"Type declaration","text":"

\u2022 new NodesApi(opts?)

"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_3","title":"Parameters","text":"Name Type opts? DerivedKubeApiOptions & IgnoredKubeApiOptions"},{"location":"extensions/api/modules/Main.K8sApi/#persistentvolumeclaimsapi_1","title":"PersistentVolumeClaimsApi","text":"

\u2022 PersistentVolumeClaimsApi: (opts?: DerivedKubeApiOptions & IgnoredKubeApiOptions) => PersistentVolumeClaimApi

"},{"location":"extensions/api/modules/Main.K8sApi/#type-declaration_4","title":"Type declaration","text":"

\u2022 new PersistentVolumeClaimsApi(opts?)

"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_4","title":"Parameters","text":"Name Type opts? DerivedKubeApiOptions & IgnoredKubeApiOptions"},{"location":"extensions/api/modules/Main.K8sApi/#podsapi_1","title":"PodsApi","text":"

\u2022 PodsApi: (opts?: DerivedKubeApiOptions & IgnoredKubeApiOptions) => PodApi

"},{"location":"extensions/api/modules/Main.K8sApi/#type-declaration_5","title":"Type declaration","text":"

\u2022 new PodsApi(opts?)

"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_5","title":"Parameters","text":"Name Type opts? DerivedKubeApiOptions & IgnoredKubeApiOptions"},{"location":"extensions/api/modules/Main.K8sApi/#apimanager","title":"apiManager","text":"

\u2022 Const apiManager: ApiManager

"},{"location":"extensions/api/modules/Main.K8sApi/#functions_1","title":"Functions","text":""},{"location":"extensions/api/modules/Main.K8sApi/#createresourcestack","title":"createResourceStack","text":"

\u25b8 createResourceStack(cluster, name): ResourceApplyingStack

"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_6","title":"Parameters","text":"Name Type cluster KubernetesCluster<KubernetesClusterMetadata, KubernetesClusterStatus, KubernetesClusterSpec> name string"},{"location":"extensions/api/modules/Main.K8sApi/#returns","title":"Returns","text":"

ResourceApplyingStack

"},{"location":"extensions/api/modules/Main.K8sApi/#forcluster","title":"forCluster","text":"

\u25b8 forCluster<Object, Api, Data>(cluster, kubeClass, apiClass): Api

"},{"location":"extensions/api/modules/Main.K8sApi/#type-parameters_5","title":"Type parameters","text":"Name Type Object extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Object> Api extends KubeApi<Object, KubeJsonApiDataFor<Object>, Api> Data extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Data>"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_7","title":"Parameters","text":"Name Type cluster ILocalKubeApiConfig kubeClass KubeObjectConstructor<Object, Data> apiClass KubeApiConstructor<Object, Api>"},{"location":"extensions/api/modules/Main.K8sApi/#returns_1","title":"Returns","text":"

Api

\u25b8 forCluster<Object, Data>(cluster, kubeClass, apiClass?): KubeApi<Object, KubeJsonApiDataFor<Object>>

"},{"location":"extensions/api/modules/Main.K8sApi/#type-parameters_6","title":"Type parameters","text":"Name Type Object extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Object> Data extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Data>"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_8","title":"Parameters","text":"Name Type cluster ILocalKubeApiConfig kubeClass KubeObjectConstructor<Object, Data> apiClass? KubeApiConstructor<Object, KubeApi<Object, KubeJsonApiDataFor<Object>>>"},{"location":"extensions/api/modules/Main.K8sApi/#returns_2","title":"Returns","text":"

KubeApi<Object, KubeJsonApiDataFor<Object>>

"},{"location":"extensions/api/modules/Main.K8sApi/#forremotecluster","title":"forRemoteCluster","text":"

\u25b8 forRemoteCluster<Object, Api, Data>(config, kubeClass, apiClass): Api

"},{"location":"extensions/api/modules/Main.K8sApi/#type-parameters_7","title":"Type parameters","text":"Name Type Object extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Object> Api extends KubeApi<Object, KubeJsonApiDataFor<Object>, Api> Data extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Data>"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_9","title":"Parameters","text":"Name Type config IRemoteKubeApiConfig kubeClass KubeObjectConstructor<Object, Data> apiClass KubeApiConstructor<Object, Api>"},{"location":"extensions/api/modules/Main.K8sApi/#returns_3","title":"Returns","text":"

Api

\u25b8 forRemoteCluster<Object, Data>(config, kubeClass, apiClass?): KubeApi<Object, KubeJsonApiDataFor<Object>>

"},{"location":"extensions/api/modules/Main.K8sApi/#type-parameters_8","title":"Type parameters","text":"Name Type Object extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Object> Data extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Data>"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_10","title":"Parameters","text":"Name Type config IRemoteKubeApiConfig kubeClass KubeObjectConstructor<Object, Data> apiClass? KubeApiConstructor<Object, KubeApi<Object, KubeJsonApiDataFor<Object>>>"},{"location":"extensions/api/modules/Main.K8sApi/#returns_4","title":"Returns","text":"

KubeApi<Object, KubeJsonApiDataFor<Object>>

"},{"location":"extensions/api/modules/Main.K8sApi/#getpodsbyownerid","title":"getPodsByOwnerId","text":"

\u25b8 getPodsByOwnerId(ownerId): Pod[]

"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_11","title":"Parameters","text":"Name Type ownerId string"},{"location":"extensions/api/modules/Main.K8sApi/#returns_5","title":"Returns","text":"

Pod[]

"},{"location":"extensions/api/modules/Main.K8sApi/#isallowedresource","title":"isAllowedResource","text":"

\u25b8 isAllowedResource(...args): boolean

Deprecated

This function never works

"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_12","title":"Parameters","text":"Name Type ...args any[]"},{"location":"extensions/api/modules/Main.K8sApi/#returns_6","title":"Returns","text":"

boolean

false

"},{"location":"extensions/api/modules/Main.K8sApi/#iskubestatusdata","title":"isKubeStatusData","text":"

\u25b8 isKubeStatusData(object): object is KubeStatusData

Is the shape of object correct for KubeStatusData

"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_13","title":"Parameters","text":"Name Type Description object unknown Some object"},{"location":"extensions/api/modules/Main.K8sApi/#returns_7","title":"Returns","text":"

object is KubeStatusData

"},{"location":"extensions/api/modules/Main.Navigation/","title":"Main.Navigation","text":"

@k8slens/extensions / Exports / Main / Navigation

"},{"location":"extensions/api/modules/Main.Navigation/#namespace-navigation","title":"Namespace: Navigation","text":"

Main.Navigation

"},{"location":"extensions/api/modules/Main.Navigation/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Main.Navigation/#functions","title":"Functions","text":"
  • navigate
"},{"location":"extensions/api/modules/Main.Navigation/#functions_1","title":"Functions","text":""},{"location":"extensions/api/modules/Main.Navigation/#navigate","title":"navigate","text":"

\u25b8 navigate(url): Promise<void>

Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.

"},{"location":"extensions/api/modules/Main.Navigation/#parameters","title":"Parameters","text":"Name Type url string"},{"location":"extensions/api/modules/Main.Navigation/#returns","title":"Returns","text":"

Promise<void>

"},{"location":"extensions/api/modules/Main.Power/","title":"Main.Power","text":"

@k8slens/extensions / Exports / Main / Power

"},{"location":"extensions/api/modules/Main.Power/#namespace-power","title":"Namespace: Power","text":"

Main.Power

"},{"location":"extensions/api/modules/Main.Power/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Main.Power/#type-aliases","title":"Type Aliases","text":"
  • PowerEventListener
"},{"location":"extensions/api/modules/Main.Power/#functions","title":"Functions","text":"
  • onResume
  • onShutdown
  • onSuspend
"},{"location":"extensions/api/modules/Main.Power/#type-aliases_1","title":"Type Aliases","text":""},{"location":"extensions/api/modules/Main.Power/#powereventlistener","title":"PowerEventListener","text":"

\u01ac PowerEventListener: () => void

"},{"location":"extensions/api/modules/Main.Power/#type-declaration","title":"Type declaration","text":"

\u25b8 (): void

Event listener for system power events

"},{"location":"extensions/api/modules/Main.Power/#returns","title":"Returns","text":"

void

"},{"location":"extensions/api/modules/Main.Power/#functions_1","title":"Functions","text":""},{"location":"extensions/api/modules/Main.Power/#onresume","title":"onResume","text":"

\u25b8 onResume(listener): Disposer

Adds event listener to system resume event

"},{"location":"extensions/api/modules/Main.Power/#parameters","title":"Parameters","text":"Name Type Description listener PowerEventListener function which will be called on system resume"},{"location":"extensions/api/modules/Main.Power/#returns_1","title":"Returns","text":"

Disposer

function to remove event listener

"},{"location":"extensions/api/modules/Main.Power/#onshutdown","title":"onShutdown","text":"

\u25b8 onShutdown(listener): Disposer

Adds event listener to the event which is emitted when the system is about to reboot or shut down

"},{"location":"extensions/api/modules/Main.Power/#parameters_1","title":"Parameters","text":"Name Type Description listener PowerEventListener function which will be called on system shutdown"},{"location":"extensions/api/modules/Main.Power/#returns_2","title":"Returns","text":"

Disposer

function to remove event listener

"},{"location":"extensions/api/modules/Main.Power/#onsuspend","title":"onSuspend","text":"

\u25b8 onSuspend(listener): Disposer

Adds event listener to system suspend events

"},{"location":"extensions/api/modules/Main.Power/#parameters_2","title":"Parameters","text":"Name Type Description listener PowerEventListener function which will be called on system suspend"},{"location":"extensions/api/modules/Main.Power/#returns_3","title":"Returns","text":"

Disposer

function to remove event listener

"},{"location":"extensions/api/modules/Main/","title":"Main","text":"

@k8slens/extensions / Exports / Main

"},{"location":"extensions/api/modules/Main/#namespace-main","title":"Namespace: Main","text":"

Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.

"},{"location":"extensions/api/modules/Main/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Main/#namespaces","title":"Namespaces","text":"
  • Catalog
  • K8sApi
  • Navigation
  • Power
"},{"location":"extensions/api/modules/Main/#classes","title":"Classes","text":"
  • Ipc
  • LensExtension
"},{"location":"extensions/api/modules/Renderer.Catalog/","title":"Renderer.Catalog","text":"

@k8slens/extensions / Exports / Renderer / Catalog

"},{"location":"extensions/api/modules/Renderer.Catalog/#namespace-catalog","title":"Namespace: Catalog","text":"

Renderer.Catalog

"},{"location":"extensions/api/modules/Renderer.Catalog/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Renderer.Catalog/#classes","title":"Classes","text":"
  • CatalogEntityRegistry
"},{"location":"extensions/api/modules/Renderer.Catalog/#variables","title":"Variables","text":"
  • activeCluster
  • catalogCategories
  • catalogEntities
"},{"location":"extensions/api/modules/Renderer.Catalog/#variables_1","title":"Variables","text":""},{"location":"extensions/api/modules/Renderer.Catalog/#activecluster","title":"activeCluster","text":"

\u2022 Const activeCluster: IComputedValue

"},{"location":"extensions/api/modules/Renderer.Catalog/#catalogcategories","title":"catalogCategories","text":"

\u2022 Const catalogCategories: CatalogCategoryRegistry

"},{"location":"extensions/api/modules/Renderer.Catalog/#catalogentities","title":"catalogEntities","text":"

\u2022 Const catalogEntities: CatalogEntityRegistry

"},{"location":"extensions/api/modules/Renderer.Component/","title":"Renderer.Component","text":"

@k8slens/extensions / Exports / Renderer / Component

"},{"location":"extensions/api/modules/Renderer.Component/#namespace-component","title":"Namespace: Component","text":"

Renderer.Component

"},{"location":"extensions/api/modules/Renderer.Component/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Renderer.Component/#references","title":"References","text":"
  • CategoryColumnRegistration
"},{"location":"extensions/api/modules/Renderer.Component/#enumerations","title":"Enumerations","text":"
  • NotificationStatus
  • TooltipPosition
"},{"location":"extensions/api/modules/Renderer.Component/#classes","title":"Classes","text":"
  • DrawerParamToggler
  • Input
  • MenuItem
  • NotificationsStore
  • PageLayout
  • SettingLayout
  • Slider
  • Spinner
  • Stepper
  • SubTitle
  • Tab
  • TableCell
  • TableHead
  • TableRow
  • Tabs
  • TerminalStore
  • Wizard
  • WizardLayout
  • WizardStep
"},{"location":"extensions/api/modules/Renderer.Component/#interfaces","title":"Interfaces","text":"
  • AdditionalCategoryColumnRegistration
  • BadgeProps
  • BarChartProps
  • BaseIconProps
  • ButtonProps
  • CheckboxProps
  • ConfirmDialogBooleanParams
  • ConfirmDialogParams
  • ConfirmDialogProps
  • CreateNotificationOptions
  • CustomPlaceholderProps
  • DialogProps
  • DrawerItemLabelsProps
  • DrawerItemProps
  • DrawerParamTogglerProps
  • DrawerProps
  • DrawerTitleProps
  • IconDataFnArg
  • IconProps
  • KubeEventDetailsProps
  • KubeObjectDetailsProps
  • KubeObjectListLayoutProps
  • KubeObjectMenuProps
  • KubeObjectMetaProps
  • LineProgressProps
  • MainLayoutProps
  • MenuActionsProps
  • MenuContextValue
  • MenuItemProps
  • MenuPosition
  • MenuProps
  • MenuStyle
  • MonacoEditorProps
  • NamespaceSelectProps
  • Notification
  • PieChartData
  • PieChartProps
  • PodDetailsListProps
  • RadioGroupProps
  • RadioProps
  • ResourceMetricsProps
  • ResourceMetricsValue
  • SearchInputProps
  • SelectOption
  • SelectProps
  • SettingLayoutProps
  • SliderProps
  • SpinnerProps
  • StatusBrickProps
  • StepperProps
  • SubTitleProps
  • SwitchProps
  • SwitcherProps
  • TabLayoutProps
  • TabLayoutRoute
  • TabProps
  • TableCellProps
  • TableHeadProps
  • TableProps
  • TableRowProps
  • TableSortParams
  • TabsProps
  • TooltipContentFormatters
  • TooltipDecoratorProps
  • TooltipProps
  • WizardCommonProps
  • WizardLayoutProps
  • WizardProps
  • WizardStepProps
"},{"location":"extensions/api/modules/Renderer.Component/#type-aliases","title":"Type Aliases","text":"
  • AtLeastOneMetricTab
  • DatasetTooltipLabel
  • DrawerPosition
  • IconData
  • InputProps
  • InputValidation
  • InputValidationResult
  • InputValidator
  • KubeItemListStore
  • LegacyAutoConvertedOptions
  • MonacoCustomTheme
  • MonacoEditorId
  • MonacoTheme
  • NamedSvg
  • NamespaceSelectSort
  • NotificationId
  • NotificationMessage
  • ShowNotification
  • SyncValidationMessage
  • TableCellElem
  • TableHeadElem
  • TableOrderBy
  • TableRowElem
  • TableSortBy
  • TableSortCallback
  • TableSortCallbacks
"},{"location":"extensions/api/modules/Renderer.Component/#variables","title":"Variables","text":"
  • CommandOverlay
  • InputValidators
  • MenuContext
  • Notifications
  • ResourceMetricsContext
  • Tooltip
  • cpuOptions
  • logTabStore
  • memoryOptions
  • notificationsStore
  • podMetricTabs
  • resizingAnchorProps
  • terminalStore
"},{"location":"extensions/api/modules/Renderer.Component/#functions","title":"Functions","text":"
  • Badge
  • BarChart
  • Button
  • Checkbox
  • ConfirmDialog
  • Dialog
  • Drawer
  • DrawerItem
  • DrawerItemLabels
  • DrawerTitle
  • FormSwitch
  • Icon
  • KubeEventDetails
  • KubeObjectDetails
  • KubeObjectListLayout
  • KubeObjectMenu
  • KubeObjectMeta
  • LineProgress
  • MainLayout
  • Menu
  • MenuActions
  • MonacoEditor
  • NamespaceSelect
  • NamespaceSelectFilter
  • PieChart
  • PodCharts
  • PodDetailsList
  • Radio
  • RadioGroup
  • ResourceMetrics
  • SearchInput
  • Select
  • StatusBrick
  • SubMenu
  • Switch
  • Switcher
  • TabLayout
  • Table
  • asyncInputValidator
  • createTerminalTab
  • getDetailsUrl
  • inputValidator
  • isAsyncValidator
  • isSvg
  • onMultiSelectFor
  • showDetails
  • unionInputValidatorsAsync
  • withTooltip
"},{"location":"extensions/api/modules/Renderer.Component/#references_1","title":"References","text":""},{"location":"extensions/api/modules/Renderer.Component/#categorycolumnregistration","title":"CategoryColumnRegistration","text":"

Re-exports CategoryColumnRegistration

"},{"location":"extensions/api/modules/Renderer.Component/#type-aliases_1","title":"Type Aliases","text":""},{"location":"extensions/api/modules/Renderer.Component/#atleastonemetrictab","title":"AtLeastOneMetricTab","text":"

\u01ac AtLeastOneMetricTab: [MetricsTab, ...MetricsTab[]]

"},{"location":"extensions/api/modules/Renderer.Component/#datasettooltiplabel","title":"DatasetTooltipLabel","text":"

\u01ac DatasetTooltipLabel: (percent: string) => string | string

"},{"location":"extensions/api/modules/Renderer.Component/#type-declaration","title":"Type declaration","text":"

\u25b8 (percent): string | string

"},{"location":"extensions/api/modules/Renderer.Component/#parameters","title":"Parameters","text":"Name Type percent string"},{"location":"extensions/api/modules/Renderer.Component/#returns","title":"Returns","text":"

string | string

"},{"location":"extensions/api/modules/Renderer.Component/#drawerposition","title":"DrawerPosition","text":"

\u01ac DrawerPosition: \"top\" | \"left\" | \"right\" | \"bottom\"

"},{"location":"extensions/api/modules/Renderer.Component/#icondata","title":"IconData","text":"

\u01ac IconData: string | React.ReactNode | (opt: IconDataFnArg) => React.ReactNode

One of the folloing: - A material icon name - A react node - Or a function that produces a react node

"},{"location":"extensions/api/modules/Renderer.Component/#inputprops","title":"InputProps","text":"

\u01ac InputProps: Omit<InputElementProps, \"onChange\" | \"onSubmit\"> & { autoSelectOnFocus?: boolean ; blurOnEnter?: boolean ; className?: string ; contentRight?: string | React.ReactNode ; defaultValue?: string ; dirty?: boolean ; iconLeft?: IconData ; iconRight?: IconData ; maxRows?: number ; multiLine?: boolean ; showErrorsAsTooltip?: boolean | Omit<TooltipProps, \"targetId\"> ; showValidationLine?: boolean ; theme?: \"round-black\" | \"round\" ; trim?: boolean ; validators?: SingleOrMany<InputValidator> ; value?: string ; onChange?: (value: string, evt: ChangeEvent<InputElement>) => void ; onSubmit?: (value: string, evt: KeyboardEvent<InputElement>) => void }

"},{"location":"extensions/api/modules/Renderer.Component/#inputvalidation","title":"InputValidation","text":"

\u01ac InputValidation<IsAsync>: (value: string, props?: InputProps) => InputValidationResult<IsAsync>

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters","title":"Type parameters","text":"Name Type IsAsync extends boolean"},{"location":"extensions/api/modules/Renderer.Component/#type-declaration_1","title":"Type declaration","text":"

\u25b8 (value, props?): InputValidationResult<IsAsync>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_1","title":"Parameters","text":"Name Type value string props? InputProps"},{"location":"extensions/api/modules/Renderer.Component/#returns_1","title":"Returns","text":"

InputValidationResult<IsAsync>

"},{"location":"extensions/api/modules/Renderer.Component/#inputvalidationresult","title":"InputValidationResult","text":"

\u01ac InputValidationResult<IsAsync>: IsAsync extends true ? Promise<void> : boolean

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_1","title":"Type parameters","text":"Name Type IsAsync extends boolean"},{"location":"extensions/api/modules/Renderer.Component/#inputvalidator","title":"InputValidator","text":"

\u01ac InputValidator<IsAsync>: SyncInputValidator | AsyncInputValidator | IsAsync extends boolean ? LegacyInputValidator : never

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_2","title":"Type parameters","text":"Name Type IsAsync extends boolean = boolean"},{"location":"extensions/api/modules/Renderer.Component/#kubeitemliststore","title":"KubeItemListStore","text":"

\u01ac KubeItemListStore<K>: ItemListStore<K, false> & SubscribableStore & { contextItems: K[] ; getByPath: (path: string) => K | undefined }

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_3","title":"Type parameters","text":"Name Type K extends KubeObject"},{"location":"extensions/api/modules/Renderer.Component/#legacyautoconvertedoptions","title":"LegacyAutoConvertedOptions","text":"

\u01ac LegacyAutoConvertedOptions: string[]

Deprecated

This should not be used anymore, convert the options yourself.

"},{"location":"extensions/api/modules/Renderer.Component/#monacocustomtheme","title":"MonacoCustomTheme","text":"

\u01ac MonacoCustomTheme: \"clouds-midnight\"

"},{"location":"extensions/api/modules/Renderer.Component/#monacoeditorid","title":"MonacoEditorId","text":"

\u01ac MonacoEditorId: string

"},{"location":"extensions/api/modules/Renderer.Component/#monacotheme","title":"MonacoTheme","text":"

\u01ac MonacoTheme: \"vs\" | \"vs-dark\" | \"hc-black\" | MonacoCustomTheme

"},{"location":"extensions/api/modules/Renderer.Component/#namedsvg","title":"NamedSvg","text":"

\u01ac NamedSvg: \"configuration\" | \"crane\" | \"group\" | \"helm\" | \"install\" | \"kube\" | \"lens-logo\" | \"license\" | \"logo-lens\" | \"logout\" | \"nodes\" | \"push_off\" | \"push_pin\" | \"spinner\" | \"ssh\" | \"storage\" | \"terminal\" | \"user\" | \"users\" | \"wheel\" | \"workloads\"

"},{"location":"extensions/api/modules/Renderer.Component/#namespaceselectsort","title":"NamespaceSelectSort","text":"

\u01ac NamespaceSelectSort: (left: string, right: string) => number

"},{"location":"extensions/api/modules/Renderer.Component/#type-declaration_2","title":"Type declaration","text":"

\u25b8 (left, right): number

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_2","title":"Parameters","text":"Name Type left string right string"},{"location":"extensions/api/modules/Renderer.Component/#returns_2","title":"Returns","text":"

number

"},{"location":"extensions/api/modules/Renderer.Component/#notificationid","title":"NotificationId","text":"

\u01ac NotificationId: string | number

"},{"location":"extensions/api/modules/Renderer.Component/#notificationmessage","title":"NotificationMessage","text":"

\u01ac NotificationMessage: string | React.ReactElement | React.ReactElement[] | JsonApiErrorParsed | Error

"},{"location":"extensions/api/modules/Renderer.Component/#shownotification","title":"ShowNotification","text":"

\u01ac ShowNotification: (message: NotificationMessage, opts?: CreateNotificationOptions) => Disposer

"},{"location":"extensions/api/modules/Renderer.Component/#type-declaration_3","title":"Type declaration","text":"

\u25b8 (message, opts?): Disposer

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_3","title":"Parameters","text":"Name Type message NotificationMessage opts? CreateNotificationOptions"},{"location":"extensions/api/modules/Renderer.Component/#returns_3","title":"Returns","text":"

Disposer

"},{"location":"extensions/api/modules/Renderer.Component/#syncvalidationmessage","title":"SyncValidationMessage","text":"

\u01ac SyncValidationMessage: React.ReactNode | (value: string, props?: InputProps) => React.ReactNode

"},{"location":"extensions/api/modules/Renderer.Component/#tablecellelem","title":"TableCellElem","text":"

\u01ac TableCellElem: React.ReactElement<TableCellProps>

"},{"location":"extensions/api/modules/Renderer.Component/#tableheadelem","title":"TableHeadElem","text":"

\u01ac TableHeadElem: React.ReactElement<TableHeadProps>

"},{"location":"extensions/api/modules/Renderer.Component/#tableorderby","title":"TableOrderBy","text":"

\u01ac TableOrderBy: \"asc\" | \"desc\"

"},{"location":"extensions/api/modules/Renderer.Component/#tablerowelem","title":"TableRowElem","text":"

\u01ac TableRowElem<Item>: React.ReactElement<TableRowProps<Item>>

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_4","title":"Type parameters","text":"Name Item"},{"location":"extensions/api/modules/Renderer.Component/#tablesortby","title":"TableSortBy","text":"

\u01ac TableSortBy: string

"},{"location":"extensions/api/modules/Renderer.Component/#tablesortcallback","title":"TableSortCallback","text":"

\u01ac TableSortCallback<Item>: (data: Item) => undefined | string | number | (string | number)[]

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_5","title":"Type parameters","text":"Name Item"},{"location":"extensions/api/modules/Renderer.Component/#type-declaration_4","title":"Type declaration","text":"

\u25b8 (data): undefined | string | number | (string | number)[]

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_4","title":"Parameters","text":"Name Type data Item"},{"location":"extensions/api/modules/Renderer.Component/#returns_4","title":"Returns","text":"

undefined | string | number | (string | number)[]

"},{"location":"extensions/api/modules/Renderer.Component/#tablesortcallbacks","title":"TableSortCallbacks","text":"

\u01ac TableSortCallbacks<Item>: Record<string, TableSortCallback<Item>>

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_6","title":"Type parameters","text":"Name Item"},{"location":"extensions/api/modules/Renderer.Component/#variables_1","title":"Variables","text":""},{"location":"extensions/api/modules/Renderer.Component/#commandoverlay","title":"CommandOverlay","text":"

\u2022 Const CommandOverlay: CommandOverlay

"},{"location":"extensions/api/modules/Renderer.Component/#inputvalidators","title":"InputValidators","text":"

\u2022 Const InputValidators: Object

"},{"location":"extensions/api/modules/Renderer.Component/#type-declaration_5","title":"Type declaration","text":"Name Type accountId Validators.SyncInputValidator isEmail Validators.SyncInputValidator isExtensionNameInstall Validators.SyncInputValidator isExtensionNameInstallRegex { captures: (val: string) => undefined | { name: string ; version?: string } ; isMatch: (val: string) => boolean } isExtensionNameInstallRegex.captures [object Object] isExtensionNameInstallRegex.isMatch [object Object] isNumber Validators.SyncInputValidator isPath Validators.AsyncInputValidator isRequired Validators.SyncInputValidator isUrl Validators.SyncInputValidator maxLength Validators.SyncInputValidator minLength Validators.SyncInputValidator systemName Validators.SyncInputValidator unionInputValidators (baseValidator: Pick<SyncInputValidator, \"message\" | \"condition\">, ...validators: SyncInputValidator[]) => SyncInputValidator"},{"location":"extensions/api/modules/Renderer.Component/#menucontext","title":"MenuContext","text":"

\u2022 Const MenuContext: React.Context<MenuContextValue | null>

"},{"location":"extensions/api/modules/Renderer.Component/#notifications","title":"Notifications","text":"

\u2022 Const Notifications: Object

"},{"location":"extensions/api/modules/Renderer.Component/#type-declaration_6","title":"Type declaration","text":"Name Type checkedError ShowCheckedErrorNotification error ShowNotification info ShowNotification ok ShowNotification shortInfo ShowNotification"},{"location":"extensions/api/modules/Renderer.Component/#resourcemetricscontext","title":"ResourceMetricsContext","text":"

\u2022 Const ResourceMetricsContext: React.Context<ResourceMetricsValue | null>

"},{"location":"extensions/api/modules/Renderer.Component/#tooltip","title":"Tooltip","text":"

\u2022 Const Tooltip: React.ComponentClass<TooltipProps, any>

"},{"location":"extensions/api/modules/Renderer.Component/#cpuoptions","title":"cpuOptions","text":"

\u2022 Const cpuOptions: ChartOptions

"},{"location":"extensions/api/modules/Renderer.Component/#logtabstore","title":"logTabStore","text":"

\u2022 Const logTabStore: LogTabStore & { createPodTab: ({ selectedPod, selectedContainer }: PodLogsTabData) => string ; createWorkloadTab: ({ workload }: WorkloadLogsTabData) => string | undefined ; renameTab: (tabId: string) => void ; tabs: undefined }

"},{"location":"extensions/api/modules/Renderer.Component/#memoryoptions","title":"memoryOptions","text":"

\u2022 Const memoryOptions: ChartOptions

"},{"location":"extensions/api/modules/Renderer.Component/#notificationsstore","title":"notificationsStore","text":"

\u2022 Const notificationsStore: NotificationsStore

"},{"location":"extensions/api/modules/Renderer.Component/#podmetrictabs","title":"podMetricTabs","text":"

\u2022 Const podMetricTabs: AtLeastOneMetricTab

"},{"location":"extensions/api/modules/Renderer.Component/#resizinganchorprops","title":"resizingAnchorProps","text":"

\u2022 Const resizingAnchorProps: Record<DrawerPosition, [ResizeDirection, ResizeSide, ResizeGrowthDirection]>

"},{"location":"extensions/api/modules/Renderer.Component/#terminalstore","title":"terminalStore","text":"

\u2022 Const terminalStore: TerminalStore & { sendCommand: SendCommand }

"},{"location":"extensions/api/modules/Renderer.Component/#functions_1","title":"Functions","text":""},{"location":"extensions/api/modules/Renderer.Component/#badge","title":"Badge","text":"

\u25b8 Badge(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_5","title":"Parameters","text":"Name Type props PropsWithChildren<BadgeProps & TooltipDecoratorProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_5","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#barchart","title":"BarChart","text":"

\u25b8 BarChart(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_6","title":"Parameters","text":"Name Type props PropsWithChildren<BarChartProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_6","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#button","title":"Button","text":"

\u25b8 Button(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_7","title":"Parameters","text":"Name Type props PropsWithChildren<ButtonProps & TooltipDecoratorProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_7","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#checkbox","title":"Checkbox","text":"

\u25b8 Checkbox(\u00abdestructured\u00bb): React.JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_8","title":"Parameters","text":"Name Type \u00abdestructured\u00bb CheckboxProps"},{"location":"extensions/api/modules/Renderer.Component/#returns_8","title":"Returns","text":"

React.JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#confirmdialog","title":"ConfirmDialog","text":"

\u25b8 ConfirmDialog(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_9","title":"Parameters","text":"Name Type props PropsWithChildren<ConfirmDialogProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_9","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#dialog","title":"Dialog","text":"

\u25b8 Dialog(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_10","title":"Parameters","text":"Name Type props PropsWithChildren<DialogProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_10","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#drawer","title":"Drawer","text":"

\u25b8 Drawer(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_11","title":"Parameters","text":"Name Type props PropsWithChildren<DrawerProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_11","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#draweritem","title":"DrawerItem","text":"

\u25b8 DrawerItem(\u00abdestructured\u00bb): React.JSX.Element | null

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_12","title":"Parameters","text":"Name Type \u00abdestructured\u00bb DrawerItemProps"},{"location":"extensions/api/modules/Renderer.Component/#returns_12","title":"Returns","text":"

React.JSX.Element | null

"},{"location":"extensions/api/modules/Renderer.Component/#draweritemlabels","title":"DrawerItemLabels","text":"

\u25b8 DrawerItemLabels(props): React.JSX.Element | null

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_13","title":"Parameters","text":"Name Type props DrawerItemLabelsProps"},{"location":"extensions/api/modules/Renderer.Component/#returns_13","title":"Returns","text":"

React.JSX.Element | null

"},{"location":"extensions/api/modules/Renderer.Component/#drawertitle","title":"DrawerTitle","text":"

\u25b8 DrawerTitle(\u00abdestructured\u00bb): React.JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_14","title":"Parameters","text":"Name Type \u00abdestructured\u00bb DrawerTitleProps"},{"location":"extensions/api/modules/Renderer.Component/#returns_14","title":"Returns","text":"

React.JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#formswitch","title":"FormSwitch","text":"

\u25b8 FormSwitch(props): React.FunctionComponentElement<any>

Deprecated

Use instead from \"../switch.tsx\".

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_15","title":"Parameters","text":"Name Type props FormControlLabelProps & { children?: ReactNode }"},{"location":"extensions/api/modules/Renderer.Component/#returns_15","title":"Returns","text":"

React.FunctionComponentElement<any>

"},{"location":"extensions/api/modules/Renderer.Component/#icon","title":"Icon","text":"

\u25b8 Icon(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_16","title":"Parameters","text":"Name Type props PropsWithChildren<IconProps & TooltipDecoratorProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_16","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#kubeeventdetails","title":"KubeEventDetails","text":"

\u25b8 KubeEventDetails(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_17","title":"Parameters","text":"Name Type props PropsWithChildren<KubeEventDetailsProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_17","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#kubeobjectdetails","title":"KubeObjectDetails","text":"

\u25b8 KubeObjectDetails(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_18","title":"Parameters","text":"Name Type props Object context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_18","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#kubeobjectlistlayout","title":"KubeObjectListLayout","text":"

\u25b8 KubeObjectListLayout<K, A, D>(props): ReactElement<any, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_7","title":"Type parameters","text":"Name Type K extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, K> A extends KubeApi<K, D, A> D extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, D> = KubeJsonApiDataFor<K>"},{"location":"extensions/api/modules/Renderer.Component/#parameters_19","title":"Parameters","text":"Name Type props KubeObjectListLayoutProps<K, A, D>"},{"location":"extensions/api/modules/Renderer.Component/#returns_19","title":"Returns","text":"

ReactElement<any, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/modules/Renderer.Component/#kubeobjectmenu","title":"KubeObjectMenu","text":"

\u25b8 KubeObjectMenu<T>(props): ReactElement<any, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_8","title":"Type parameters","text":"Name Type T extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, T>"},{"location":"extensions/api/modules/Renderer.Component/#parameters_20","title":"Parameters","text":"Name Type props KubeObjectMenuProps<T>"},{"location":"extensions/api/modules/Renderer.Component/#returns_20","title":"Returns","text":"

ReactElement<any, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/modules/Renderer.Component/#kubeobjectmeta","title":"KubeObjectMeta","text":"

\u25b8 KubeObjectMeta(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_21","title":"Parameters","text":"Name Type props PropsWithChildren<KubeObjectMetaProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_21","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#lineprogress","title":"LineProgress","text":"

\u25b8 LineProgress(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_22","title":"Parameters","text":"Name Type props PropsWithChildren<LineProgressProps & TooltipDecoratorProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_22","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#mainlayout","title":"MainLayout","text":"

\u25b8 MainLayout(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_23","title":"Parameters","text":"Name Type props PropsWithChildren<MainLayoutProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_23","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#menu","title":"Menu","text":"

\u25b8 Menu(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_24","title":"Parameters","text":"Name Type props PropsWithChildren<MenuProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_24","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#menuactions","title":"MenuActions","text":"

\u25b8 MenuActions(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_25","title":"Parameters","text":"Name Type props PropsWithChildren<MenuActionsProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_25","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#monacoeditor","title":"MonacoEditor","text":"

\u25b8 MonacoEditor(props): null | ReactElement<any, string | JSXElementConstructor<any>>

NOTE: Exotic components are not callable.

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_26","title":"Parameters","text":"Name Type props MonacoEditorProps & RefAttributes<MonacoEditorRef>"},{"location":"extensions/api/modules/Renderer.Component/#returns_26","title":"Returns","text":"

null | ReactElement<any, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/modules/Renderer.Component/#namespaceselect","title":"NamespaceSelect","text":"

\u25b8 NamespaceSelect<IsMulti>(props): JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_9","title":"Type parameters","text":"Name Type IsMulti extends boolean = false"},{"location":"extensions/api/modules/Renderer.Component/#parameters_27","title":"Parameters","text":"Name Type props NamespaceSelectProps<IsMulti>"},{"location":"extensions/api/modules/Renderer.Component/#returns_27","title":"Returns","text":"

JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#namespaceselectfilter","title":"NamespaceSelectFilter","text":"

\u25b8 NamespaceSelectFilter(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_28","title":"Parameters","text":"Name Type props PropsWithChildren<NamespaceSelectFilterProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_28","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#piechart","title":"PieChart","text":"

\u25b8 PieChart(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_29","title":"Parameters","text":"Name Type props PropsWithChildren<PieChartProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_29","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#podcharts","title":"PodCharts","text":"

\u25b8 PodCharts(): null | Element

"},{"location":"extensions/api/modules/Renderer.Component/#returns_30","title":"Returns","text":"

null | Element

"},{"location":"extensions/api/modules/Renderer.Component/#poddetailslist","title":"PodDetailsList","text":"

\u25b8 PodDetailsList(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_30","title":"Parameters","text":"Name Type props PropsWithChildren<PodDetailsListProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_31","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#radio","title":"Radio","text":"

\u25b8 Radio<T>(\u00abdestructured\u00bb): React.JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_10","title":"Type parameters","text":"Name T"},{"location":"extensions/api/modules/Renderer.Component/#parameters_31","title":"Parameters","text":"Name Type \u00abdestructured\u00bb RadioProps<T>"},{"location":"extensions/api/modules/Renderer.Component/#returns_32","title":"Returns","text":"

React.JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#radiogroup","title":"RadioGroup","text":"

\u25b8 RadioGroup<T>(\u00abdestructured\u00bb): React.JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_11","title":"Type parameters","text":"Name T"},{"location":"extensions/api/modules/Renderer.Component/#parameters_32","title":"Parameters","text":"Name Type \u00abdestructured\u00bb RadioGroupProps<T>"},{"location":"extensions/api/modules/Renderer.Component/#returns_33","title":"Returns","text":"

React.JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#resourcemetrics","title":"ResourceMetrics","text":"

\u25b8 ResourceMetrics<Keys>(\u00abdestructured\u00bb): Element

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_12","title":"Type parameters","text":"Name Type Keys extends string"},{"location":"extensions/api/modules/Renderer.Component/#parameters_33","title":"Parameters","text":"Name Type \u00abdestructured\u00bb ResourceMetricsProps<Keys>"},{"location":"extensions/api/modules/Renderer.Component/#returns_34","title":"Returns","text":"

Element

"},{"location":"extensions/api/modules/Renderer.Component/#searchinput","title":"SearchInput","text":"

\u25b8 SearchInput(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_34","title":"Parameters","text":"Name Type props PropsWithChildren<SearchInputProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_35","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#select","title":"Select","text":"

\u25b8 Select<Value, Option, IsMulti, Group>(props): ReactElement<any, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_13","title":"Type parameters","text":"Name Type Value Value Option extends SelectOption<Value, Option> IsMulti extends boolean = false Group extends GroupBase<Option, Group> = GroupBase<Option>"},{"location":"extensions/api/modules/Renderer.Component/#parameters_35","title":"Parameters","text":"Name Type props SelectProps<Value, Option, IsMulti, Group>"},{"location":"extensions/api/modules/Renderer.Component/#returns_36","title":"Returns","text":"

ReactElement<any, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/modules/Renderer.Component/#statusbrick","title":"StatusBrick","text":"

\u25b8 StatusBrick(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_36","title":"Parameters","text":"Name Type props PropsWithChildren<StatusBrickProps & TooltipDecoratorProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_37","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#submenu","title":"SubMenu","text":"

\u25b8 SubMenu(props): React.JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_37","title":"Parameters","text":"Name Type props Partial<MenuProps>"},{"location":"extensions/api/modules/Renderer.Component/#returns_38","title":"Returns","text":"

React.JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#switch","title":"Switch","text":"

\u25b8 Switch(\u00abdestructured\u00bb): React.JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_38","title":"Parameters","text":"Name Type \u00abdestructured\u00bb SwitchProps"},{"location":"extensions/api/modules/Renderer.Component/#returns_39","title":"Returns","text":"

React.JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#switcher","title":"Switcher","text":"

\u25b8 Switcher(\u00abdestructured\u00bb): React.JSX.Element

Deprecated

Use instead from \"../switch.tsx\".

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_39","title":"Parameters","text":"Name Type \u00abdestructured\u00bb SwitcherProps"},{"location":"extensions/api/modules/Renderer.Component/#returns_40","title":"Returns","text":"

React.JSX.Element

"},{"location":"extensions/api/modules/Renderer.Component/#tablayout","title":"TabLayout","text":"

\u25b8 TabLayout(props, context?): null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_40","title":"Parameters","text":"Name Type props PropsWithChildren<TabLayoutProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_41","title":"Returns","text":"

null | ReactElement<any, any>

"},{"location":"extensions/api/modules/Renderer.Component/#table","title":"Table","text":"

\u25b8 Table<Item>(props): ReactElement<any, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_14","title":"Type parameters","text":"Name Item"},{"location":"extensions/api/modules/Renderer.Component/#parameters_41","title":"Parameters","text":"Name Type props TableProps<Item>"},{"location":"extensions/api/modules/Renderer.Component/#returns_42","title":"Returns","text":"

ReactElement<any, string | JSXElementConstructor<any>>

"},{"location":"extensions/api/modules/Renderer.Component/#asyncinputvalidator","title":"asyncInputValidator","text":"

\u25b8 asyncInputValidator(validator): AsyncInputValidator

A helper function to create an AsyncInputValidator

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_42","title":"Parameters","text":"Name Type validator AsyncInputValidator"},{"location":"extensions/api/modules/Renderer.Component/#returns_43","title":"Returns","text":"

AsyncInputValidator

"},{"location":"extensions/api/modules/Renderer.Component/#createterminaltab","title":"createTerminalTab","text":"

\u25b8 createTerminalTab(tabParams?): Required<DockTabCreate>

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_43","title":"Parameters","text":"Name Type tabParams? DockTabCreateSpecific"},{"location":"extensions/api/modules/Renderer.Component/#returns_44","title":"Returns","text":"

Required<DockTabCreate>

"},{"location":"extensions/api/modules/Renderer.Component/#getdetailsurl","title":"getDetailsUrl","text":"

\u25b8 getDetailsUrl(selfLink, resetSelected?, mergeGlobals?): string

Deprecated

Use Renderer.Navigation.getDetailsUrl

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_44","title":"Parameters","text":"Name Type selfLink string resetSelected? boolean mergeGlobals? boolean"},{"location":"extensions/api/modules/Renderer.Component/#returns_45","title":"Returns","text":"

string

"},{"location":"extensions/api/modules/Renderer.Component/#inputvalidator_1","title":"inputValidator","text":"

\u25b8 inputValidator(validator): SyncInputValidator

A helper function to create an SyncInputValidator

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_45","title":"Parameters","text":"Name Type validator SyncInputValidator"},{"location":"extensions/api/modules/Renderer.Component/#returns_46","title":"Returns","text":"

SyncInputValidator

"},{"location":"extensions/api/modules/Renderer.Component/#isasyncvalidator","title":"isAsyncValidator","text":"

\u25b8 isAsyncValidator(validator): validator is AsyncInputValidator

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_46","title":"Parameters","text":"Name Type validator InputValidator<boolean>"},{"location":"extensions/api/modules/Renderer.Component/#returns_47","title":"Returns","text":"

validator is AsyncInputValidator

"},{"location":"extensions/api/modules/Renderer.Component/#issvg","title":"isSvg","text":"

\u25b8 isSvg(content): boolean

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_47","title":"Parameters","text":"Name Type content string"},{"location":"extensions/api/modules/Renderer.Component/#returns_48","title":"Returns","text":"

boolean

"},{"location":"extensions/api/modules/Renderer.Component/#onmultiselectfor","title":"onMultiSelectFor","text":"

\u25b8 onMultiSelectFor<Value, Option, Group>(collection): SelectProps<Value, Option, true, Group>[\"onChange\"]

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_15","title":"Type parameters","text":"Name Type Value Value Option extends SelectOption<Value, Option> Group extends GroupBase<Option, Group> = GroupBase<Option>"},{"location":"extensions/api/modules/Renderer.Component/#parameters_48","title":"Parameters","text":"Name Type collection Set<Value> | ObservableSet<Value>"},{"location":"extensions/api/modules/Renderer.Component/#returns_49","title":"Returns","text":"

SelectProps<Value, Option, true, Group>[\"onChange\"]

"},{"location":"extensions/api/modules/Renderer.Component/#showdetails","title":"showDetails","text":"

\u25b8 showDetails(selfLink, resetSelected?): void

Deprecated

Use Renderer.Navigation.showDetails

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_49","title":"Parameters","text":"Name Type selfLink undefined | string resetSelected? boolean"},{"location":"extensions/api/modules/Renderer.Component/#returns_50","title":"Returns","text":"

void

"},{"location":"extensions/api/modules/Renderer.Component/#unioninputvalidatorsasync","title":"unionInputValidatorsAsync","text":"

\u25b8 unionInputValidatorsAsync(baseValidator, ...validators): AsyncInputValidator

Create a new input validator from a list of syncronous or async input validators. Will match as valid if one of the input validators matches the input

"},{"location":"extensions/api/modules/Renderer.Component/#parameters_50","title":"Parameters","text":"Name Type baseValidator Object baseValidator.condition undefined | (props: InputProps) => any | (props: InputProps) => any | (props: InputProps) => any baseValidator.message null | string | number | boolean | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | (value: string, props?: InputProps) => ReactNode ...validators InputValidator<boolean>[]"},{"location":"extensions/api/modules/Renderer.Component/#returns_51","title":"Returns","text":"

AsyncInputValidator

"},{"location":"extensions/api/modules/Renderer.Component/#withtooltip","title":"withTooltip","text":"

\u25b8 withTooltip<TargetProps>(Target): React.FunctionComponent<TargetProps & TooltipDecoratorProps>

"},{"location":"extensions/api/modules/Renderer.Component/#type-parameters_16","title":"Type parameters","text":"Name TargetProps"},{"location":"extensions/api/modules/Renderer.Component/#parameters_51","title":"Parameters","text":"Name Type Target TargetProps extends Pick<TooltipDecoratorProps, \"id\" | \"children\"> ? FunctionComponent<TargetProps> : never"},{"location":"extensions/api/modules/Renderer.Component/#returns_52","title":"Returns","text":"

React.FunctionComponent<TargetProps & TooltipDecoratorProps>

"},{"location":"extensions/api/modules/Renderer.K8sApi/","title":"Renderer.K8sApi","text":"

@k8slens/extensions / Exports / Renderer / K8sApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#namespace-k8sapi","title":"Namespace: K8sApi","text":"

Renderer.K8sApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Renderer.K8sApi/#references","title":"References","text":"
  • BaseKubeJsonApiObjectMetadata
  • ClusterRole
  • ClusterRoleBinding
  • ClusterScopedMetadata
  • ConfigMap
  • CronJob
  • CustomResourceDefinition
  • DaemonSet
  • Deployment
  • DeploymentApi
  • Endpoint
  • ExternalKubeApiOptions
  • HorizontalPodAutoscaler
  • HorizontalPodAutoscalerStore
  • IKubeApiCluster
  • ILocalKubeApiConfig
  • IPodContainer
  • IPodContainerStatus
  • IRemoteKubeApiConfig
  • ISecretRef
  • IgnoredKubeApiOptions
  • Ingress
  • IngressApi
  • Job
  • JsonPatch
  • KubeApi
  • KubeEvent
  • KubeJsonApi
  • KubeJsonApiData
  • KubeJsonApiDataFor
  • KubeJsonApiObjectMetadata
  • KubeObject
  • KubeObjectMetadata
  • KubeObjectStore
  • KubeObjectStoreLoadAllParams
  • KubeObjectStoreLoadingParams
  • KubeObjectStoreSubscribeParams
  • KubeStatus
  • KubeStatusData
  • LimitRange
  • Namespace
  • NamespaceScopedMetadata
  • NetworkPolicy
  • Node
  • NodesApi
  • OwnerReference
  • PersistentVolume
  • PersistentVolumeClaim
  • PersistentVolumeClaimsApi
  • Pod
  • PodDisruptionBudget
  • PodsApi
  • PriorityClass
  • ReplicaSet
  • ResourceQuota
  • ResourceStack
  • Role
  • RoleBinding
  • Secret
  • Service
  • ServiceAccount
  • StatefulSet
  • StorageClass
  • apiManager
  • createKubeObject
  • createResourceStack
  • forCluster
  • forRemoteCluster
  • getPodsByOwnerId
  • isJsonApiData
  • isJsonApiDataList
  • isKubeJsonApiListMetadata
  • isKubeJsonApiMetadata
  • isKubeObjectNonSystem
  • isKubeStatusData
  • isPartialJsonApiData
  • isPartialJsonApiMetadata
  • stringifyLabels
"},{"location":"extensions/api/modules/Renderer.K8sApi/#enumerations","title":"Enumerations","text":"
  • KubeObjectStatusLevel
"},{"location":"extensions/api/modules/Renderer.K8sApi/#classes","title":"Classes","text":"
  • CRDResourceStore
  • CRDStore
  • ConfigMapsStore
  • CronJobStore
  • DaemonSetStore
  • DeploymentStore
  • EndpointStore
  • EventStore
  • HPAStore
  • IngressClassStore
  • IngressStore
  • JobStore
  • LimitRangesStore
  • NamespaceStore
  • NetworkPolicyStore
  • NodesStore
  • PersistentVolumesStore
  • PodDisruptionBudgetsStore
  • PodsStore
  • PriorityClassStoreStore
  • ReplicaSetStore
  • ResourceQuotasStore
  • RoleBindingsStore
  • RolesStore
  • SecretsStore
  • ServiceAccountsStore
  • ServiceStore
  • StatefulSetStore
  • StorageClassStore
  • VerticalPodAutoscalerStore
  • VolumeClaimStore
"},{"location":"extensions/api/modules/Renderer.K8sApi/#interfaces","title":"Interfaces","text":"
  • KubeObjectStatus
  • MetricData
  • MetricResult
  • RequestMetricsParams
"},{"location":"extensions/api/modules/Renderer.K8sApi/#type-aliases","title":"Type Aliases","text":"
  • RequestMetrics
"},{"location":"extensions/api/modules/Renderer.K8sApi/#variables","title":"Variables","text":"
  • clusterRoleApi
  • clusterRoleBindingApi
  • configMapApi
  • crdApi
  • cronJobApi
  • daemonSetApi
  • deploymentApi
  • endpointApi
  • eventApi
  • hpaApi
  • ingressApi
  • jobApi
  • limitRangeApi
  • namespacesApi
  • networkPolicyApi
  • nodesApi
  • pcApi
  • pdbApi
  • persistentVolumeApi
  • podsApi
  • pvcApi
  • replicaSetApi
  • resourceQuotaApi
  • roleApi
  • roleBindingApi
  • secretsApi
  • serviceAccountsApi
  • serviceApi
  • statefulSetApi
  • storageClassApi
  • vpaApi
"},{"location":"extensions/api/modules/Renderer.K8sApi/#functions","title":"Functions","text":"
  • isAllowedResource
  • requestMetrics
"},{"location":"extensions/api/modules/Renderer.K8sApi/#references_1","title":"References","text":""},{"location":"extensions/api/modules/Renderer.K8sApi/#basekubejsonapiobjectmetadata","title":"BaseKubeJsonApiObjectMetadata","text":"

Re-exports BaseKubeJsonApiObjectMetadata

"},{"location":"extensions/api/modules/Renderer.K8sApi/#clusterrole","title":"ClusterRole","text":"

Re-exports ClusterRole

"},{"location":"extensions/api/modules/Renderer.K8sApi/#clusterrolebinding","title":"ClusterRoleBinding","text":"

Re-exports ClusterRoleBinding

"},{"location":"extensions/api/modules/Renderer.K8sApi/#clusterscopedmetadata","title":"ClusterScopedMetadata","text":"

Re-exports ClusterScopedMetadata

"},{"location":"extensions/api/modules/Renderer.K8sApi/#configmap","title":"ConfigMap","text":"

Re-exports ConfigMap

"},{"location":"extensions/api/modules/Renderer.K8sApi/#cronjob","title":"CronJob","text":"

Re-exports CronJob

"},{"location":"extensions/api/modules/Renderer.K8sApi/#customresourcedefinition","title":"CustomResourceDefinition","text":"

Re-exports CustomResourceDefinition

"},{"location":"extensions/api/modules/Renderer.K8sApi/#daemonset","title":"DaemonSet","text":"

Re-exports DaemonSet

"},{"location":"extensions/api/modules/Renderer.K8sApi/#deployment","title":"Deployment","text":"

Re-exports Deployment

"},{"location":"extensions/api/modules/Renderer.K8sApi/#deploymentapi","title":"DeploymentApi","text":"

Re-exports DeploymentApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#endpoint","title":"Endpoint","text":"

Re-exports Endpoint

"},{"location":"extensions/api/modules/Renderer.K8sApi/#externalkubeapioptions","title":"ExternalKubeApiOptions","text":"

Re-exports ExternalKubeApiOptions

"},{"location":"extensions/api/modules/Renderer.K8sApi/#horizontalpodautoscaler","title":"HorizontalPodAutoscaler","text":"

Re-exports HorizontalPodAutoscaler

"},{"location":"extensions/api/modules/Renderer.K8sApi/#horizontalpodautoscalerstore","title":"HorizontalPodAutoscalerStore","text":"

Renames and re-exports HPAStore

"},{"location":"extensions/api/modules/Renderer.K8sApi/#ikubeapicluster","title":"IKubeApiCluster","text":"

Re-exports IKubeApiCluster

"},{"location":"extensions/api/modules/Renderer.K8sApi/#ilocalkubeapiconfig","title":"ILocalKubeApiConfig","text":"

Re-exports ILocalKubeApiConfig

"},{"location":"extensions/api/modules/Renderer.K8sApi/#ipodcontainer","title":"IPodContainer","text":"

Re-exports IPodContainer

"},{"location":"extensions/api/modules/Renderer.K8sApi/#ipodcontainerstatus","title":"IPodContainerStatus","text":"

Re-exports IPodContainerStatus

"},{"location":"extensions/api/modules/Renderer.K8sApi/#iremotekubeapiconfig","title":"IRemoteKubeApiConfig","text":"

Re-exports IRemoteKubeApiConfig

"},{"location":"extensions/api/modules/Renderer.K8sApi/#isecretref","title":"ISecretRef","text":"

Re-exports ISecretRef

"},{"location":"extensions/api/modules/Renderer.K8sApi/#ignoredkubeapioptions","title":"IgnoredKubeApiOptions","text":"

Re-exports IgnoredKubeApiOptions

"},{"location":"extensions/api/modules/Renderer.K8sApi/#ingress","title":"Ingress","text":"

Re-exports Ingress

"},{"location":"extensions/api/modules/Renderer.K8sApi/#ingressapi","title":"IngressApi","text":"

Re-exports IngressApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#job","title":"Job","text":"

Re-exports Job

"},{"location":"extensions/api/modules/Renderer.K8sApi/#jsonpatch","title":"JsonPatch","text":"

Re-exports JsonPatch

"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeapi","title":"KubeApi","text":"

Re-exports KubeApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeevent","title":"KubeEvent","text":"

Re-exports KubeEvent

"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubejsonapi","title":"KubeJsonApi","text":"

Re-exports KubeJsonApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubejsonapidata","title":"KubeJsonApiData","text":"

Re-exports KubeJsonApiData

"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubejsonapidatafor","title":"KubeJsonApiDataFor","text":"

Re-exports KubeJsonApiDataFor

"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubejsonapiobjectmetadata","title":"KubeJsonApiObjectMetadata","text":"

Re-exports KubeJsonApiObjectMetadata

"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeobject","title":"KubeObject","text":"

Re-exports KubeObject

"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeobjectmetadata","title":"KubeObjectMetadata","text":"

Re-exports KubeObjectMetadata

"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeobjectstore","title":"KubeObjectStore","text":"

Re-exports KubeObjectStore

"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeobjectstoreloadallparams","title":"KubeObjectStoreLoadAllParams","text":"

Re-exports KubeObjectStoreLoadAllParams

"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeobjectstoreloadingparams","title":"KubeObjectStoreLoadingParams","text":"

Re-exports KubeObjectStoreLoadingParams

"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeobjectstoresubscribeparams","title":"KubeObjectStoreSubscribeParams","text":"

Re-exports KubeObjectStoreSubscribeParams

"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubestatus","title":"KubeStatus","text":"

Re-exports KubeStatus

"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubestatusdata","title":"KubeStatusData","text":"

Re-exports KubeStatusData

"},{"location":"extensions/api/modules/Renderer.K8sApi/#limitrange","title":"LimitRange","text":"

Re-exports LimitRange

"},{"location":"extensions/api/modules/Renderer.K8sApi/#namespace","title":"Namespace","text":"

Re-exports Namespace

"},{"location":"extensions/api/modules/Renderer.K8sApi/#namespacescopedmetadata","title":"NamespaceScopedMetadata","text":"

Re-exports NamespaceScopedMetadata

"},{"location":"extensions/api/modules/Renderer.K8sApi/#networkpolicy","title":"NetworkPolicy","text":"

Re-exports NetworkPolicy

"},{"location":"extensions/api/modules/Renderer.K8sApi/#node","title":"Node","text":"

Re-exports Node

"},{"location":"extensions/api/modules/Renderer.K8sApi/#nodesapi","title":"NodesApi","text":"

Re-exports NodesApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#ownerreference","title":"OwnerReference","text":"

Re-exports OwnerReference

"},{"location":"extensions/api/modules/Renderer.K8sApi/#persistentvolume","title":"PersistentVolume","text":"

Re-exports PersistentVolume

"},{"location":"extensions/api/modules/Renderer.K8sApi/#persistentvolumeclaim","title":"PersistentVolumeClaim","text":"

Re-exports PersistentVolumeClaim

"},{"location":"extensions/api/modules/Renderer.K8sApi/#persistentvolumeclaimsapi","title":"PersistentVolumeClaimsApi","text":"

Re-exports PersistentVolumeClaimsApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#pod","title":"Pod","text":"

Re-exports Pod

"},{"location":"extensions/api/modules/Renderer.K8sApi/#poddisruptionbudget","title":"PodDisruptionBudget","text":"

Re-exports PodDisruptionBudget

"},{"location":"extensions/api/modules/Renderer.K8sApi/#podsapi","title":"PodsApi","text":"

Re-exports PodsApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#priorityclass","title":"PriorityClass","text":"

Re-exports PriorityClass

"},{"location":"extensions/api/modules/Renderer.K8sApi/#replicaset","title":"ReplicaSet","text":"

Re-exports ReplicaSet

"},{"location":"extensions/api/modules/Renderer.K8sApi/#resourcequota","title":"ResourceQuota","text":"

Re-exports ResourceQuota

"},{"location":"extensions/api/modules/Renderer.K8sApi/#resourcestack","title":"ResourceStack","text":"

Re-exports ResourceStack

"},{"location":"extensions/api/modules/Renderer.K8sApi/#role","title":"Role","text":"

Re-exports Role

"},{"location":"extensions/api/modules/Renderer.K8sApi/#rolebinding","title":"RoleBinding","text":"

Re-exports RoleBinding

"},{"location":"extensions/api/modules/Renderer.K8sApi/#secret","title":"Secret","text":"

Re-exports Secret

"},{"location":"extensions/api/modules/Renderer.K8sApi/#service","title":"Service","text":"

Re-exports Service

"},{"location":"extensions/api/modules/Renderer.K8sApi/#serviceaccount","title":"ServiceAccount","text":"

Re-exports ServiceAccount

"},{"location":"extensions/api/modules/Renderer.K8sApi/#statefulset","title":"StatefulSet","text":"

Re-exports StatefulSet

"},{"location":"extensions/api/modules/Renderer.K8sApi/#storageclass","title":"StorageClass","text":"

Re-exports StorageClass

"},{"location":"extensions/api/modules/Renderer.K8sApi/#apimanager","title":"apiManager","text":"

Re-exports apiManager

"},{"location":"extensions/api/modules/Renderer.K8sApi/#createkubeobject","title":"createKubeObject","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Renderer.K8sApi/#createresourcestack","title":"createResourceStack","text":"

Re-exports createResourceStack

"},{"location":"extensions/api/modules/Renderer.K8sApi/#forcluster","title":"forCluster","text":"

Re-exports forCluster

"},{"location":"extensions/api/modules/Renderer.K8sApi/#forremotecluster","title":"forRemoteCluster","text":"

Re-exports forRemoteCluster

"},{"location":"extensions/api/modules/Renderer.K8sApi/#getpodsbyownerid","title":"getPodsByOwnerId","text":"

Re-exports getPodsByOwnerId

"},{"location":"extensions/api/modules/Renderer.K8sApi/#isjsonapidata","title":"isJsonApiData","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Renderer.K8sApi/#isjsonapidatalist","title":"isJsonApiDataList","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Renderer.K8sApi/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Renderer.K8sApi/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Renderer.K8sApi/#iskubeobjectnonsystem","title":"isKubeObjectNonSystem","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Renderer.K8sApi/#iskubestatusdata","title":"isKubeStatusData","text":"

Re-exports isKubeStatusData

"},{"location":"extensions/api/modules/Renderer.K8sApi/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Renderer.K8sApi/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Renderer.K8sApi/#stringifylabels","title":"stringifyLabels","text":"

Renames and re-exports __type

"},{"location":"extensions/api/modules/Renderer.K8sApi/#type-aliases_1","title":"Type Aliases","text":""},{"location":"extensions/api/modules/Renderer.K8sApi/#requestmetrics","title":"RequestMetrics","text":"

\u01ac RequestMetrics: ReturnType<typeof requestMetricsInjectable[\"instantiate\"]>

"},{"location":"extensions/api/modules/Renderer.K8sApi/#variables_1","title":"Variables","text":""},{"location":"extensions/api/modules/Renderer.K8sApi/#clusterroleapi","title":"clusterRoleApi","text":"

\u2022 Const clusterRoleApi: ClusterRoleApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#clusterrolebindingapi","title":"clusterRoleBindingApi","text":"

\u2022 Const clusterRoleBindingApi: ClusterRoleBindingApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#configmapapi","title":"configMapApi","text":"

\u2022 Const configMapApi: ConfigMapApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#crdapi","title":"crdApi","text":"

\u2022 Const crdApi: CustomResourceDefinitionApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#cronjobapi","title":"cronJobApi","text":"

\u2022 Const cronJobApi: CronJobApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#daemonsetapi","title":"daemonSetApi","text":"

\u2022 Const daemonSetApi: DaemonSetApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#deploymentapi_1","title":"deploymentApi","text":"

\u2022 Const deploymentApi: DeploymentApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#endpointapi","title":"endpointApi","text":"

\u2022 Const endpointApi: EndpointsApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#eventapi","title":"eventApi","text":"

\u2022 Const eventApi: KubeEventApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#hpaapi","title":"hpaApi","text":"

\u2022 Const hpaApi: HorizontalPodAutoscalerApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#ingressapi_1","title":"ingressApi","text":"

\u2022 Const ingressApi: IngressApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#jobapi","title":"jobApi","text":"

\u2022 Const jobApi: JobApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#limitrangeapi","title":"limitRangeApi","text":"

\u2022 Const limitRangeApi: LimitRangeApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#namespacesapi","title":"namespacesApi","text":"

\u2022 Const namespacesApi: NamespaceApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#networkpolicyapi","title":"networkPolicyApi","text":"

\u2022 Const networkPolicyApi: NetworkPolicyApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#nodesapi_1","title":"nodesApi","text":"

\u2022 Const nodesApi: NodeApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#pcapi","title":"pcApi","text":"

\u2022 Const pcApi: PriorityClassApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#pdbapi","title":"pdbApi","text":"

\u2022 Const pdbApi: PodDisruptionBudgetApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#persistentvolumeapi","title":"persistentVolumeApi","text":"

\u2022 Const persistentVolumeApi: PersistentVolumeApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#podsapi_1","title":"podsApi","text":"

\u2022 Const podsApi: PodApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#pvcapi","title":"pvcApi","text":"

\u2022 Const pvcApi: PersistentVolumeClaimApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#replicasetapi","title":"replicaSetApi","text":"

\u2022 Const replicaSetApi: ReplicaSetApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#resourcequotaapi","title":"resourceQuotaApi","text":"

\u2022 Const resourceQuotaApi: ResourceQuotaApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#roleapi","title":"roleApi","text":"

\u2022 Const roleApi: RoleApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#rolebindingapi","title":"roleBindingApi","text":"

\u2022 Const roleBindingApi: RoleBindingApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#secretsapi","title":"secretsApi","text":"

\u2022 Const secretsApi: SecretApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#serviceaccountsapi","title":"serviceAccountsApi","text":"

\u2022 Const serviceAccountsApi: ServiceAccountApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#serviceapi","title":"serviceApi","text":"

\u2022 Const serviceApi: ServiceApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#statefulsetapi","title":"statefulSetApi","text":"

\u2022 Const statefulSetApi: StatefulSetApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#storageclassapi","title":"storageClassApi","text":"

\u2022 Const storageClassApi: StorageClassApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#vpaapi","title":"vpaApi","text":"

\u2022 Const vpaApi: VerticalPodAutoscalerApi

"},{"location":"extensions/api/modules/Renderer.K8sApi/#functions_1","title":"Functions","text":""},{"location":"extensions/api/modules/Renderer.K8sApi/#isallowedresource","title":"isAllowedResource","text":"

\u25b8 isAllowedResource(resources): boolean

"},{"location":"extensions/api/modules/Renderer.K8sApi/#parameters","title":"Parameters","text":"Name Type resources KubeResource | KubeResource[]"},{"location":"extensions/api/modules/Renderer.K8sApi/#returns","title":"Returns","text":"

boolean

"},{"location":"extensions/api/modules/Renderer.K8sApi/#requestmetrics_1","title":"requestMetrics","text":"

\u25b8 requestMetrics(query, params?): Promise<MetricData>

"},{"location":"extensions/api/modules/Renderer.K8sApi/#parameters_1","title":"Parameters","text":"Name Type query string params? RequestMetricsParams"},{"location":"extensions/api/modules/Renderer.K8sApi/#returns_1","title":"Returns","text":"

Promise<MetricData>

\u25b8 requestMetrics(query, params?): Promise<MetricData[]>

"},{"location":"extensions/api/modules/Renderer.K8sApi/#parameters_2","title":"Parameters","text":"Name Type query string[] params? RequestMetricsParams"},{"location":"extensions/api/modules/Renderer.K8sApi/#returns_2","title":"Returns","text":"

Promise<MetricData[]>

\u25b8 requestMetrics<Keys>(query, params?): Promise<Record<Keys, MetricData>>

"},{"location":"extensions/api/modules/Renderer.K8sApi/#type-parameters","title":"Type parameters","text":"Name Type Keys extends string"},{"location":"extensions/api/modules/Renderer.K8sApi/#parameters_3","title":"Parameters","text":"Name Type query Record<Keys, Partial<Record<string, string>>> params? RequestMetricsParams"},{"location":"extensions/api/modules/Renderer.K8sApi/#returns_3","title":"Returns","text":"

Promise<Record<Keys, MetricData>>

"},{"location":"extensions/api/modules/Renderer.Navigation/","title":"Renderer.Navigation","text":"

@k8slens/extensions / Exports / Renderer / Navigation

"},{"location":"extensions/api/modules/Renderer.Navigation/#namespace-navigation","title":"Namespace: Navigation","text":"

Renderer.Navigation

"},{"location":"extensions/api/modules/Renderer.Navigation/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Renderer.Navigation/#classes","title":"Classes","text":"
  • PageParam
"},{"location":"extensions/api/modules/Renderer.Navigation/#interfaces","title":"Interfaces","text":"
  • PageParamInit
  • URLParams
"},{"location":"extensions/api/modules/Renderer.Navigation/#functions","title":"Functions","text":"
  • createPageParam
  • getDetailsUrl
  • hideDetails
  • hideEntityDetails
  • isActiveRoute
  • navigate
  • showDetails
  • showEntityDetails
"},{"location":"extensions/api/modules/Renderer.Navigation/#functions_1","title":"Functions","text":""},{"location":"extensions/api/modules/Renderer.Navigation/#createpageparam","title":"createPageParam","text":"

\u25b8 createPageParam<Value>(init): PageParam<Value>

"},{"location":"extensions/api/modules/Renderer.Navigation/#type-parameters","title":"Type parameters","text":"Name Type Value string"},{"location":"extensions/api/modules/Renderer.Navigation/#parameters","title":"Parameters","text":"Name Type init PageParamInit<Value>"},{"location":"extensions/api/modules/Renderer.Navigation/#returns","title":"Returns","text":"

PageParam<Value>

"},{"location":"extensions/api/modules/Renderer.Navigation/#getdetailsurl","title":"getDetailsUrl","text":"

\u25b8 getDetailsUrl(selfLink, resetSelected?, mergeGlobals?): string

"},{"location":"extensions/api/modules/Renderer.Navigation/#parameters_1","title":"Parameters","text":"Name Type selfLink string resetSelected? boolean mergeGlobals? boolean"},{"location":"extensions/api/modules/Renderer.Navigation/#returns_1","title":"Returns","text":"

string

"},{"location":"extensions/api/modules/Renderer.Navigation/#hidedetails","title":"hideDetails","text":"

\u25b8 hideDetails(): void

"},{"location":"extensions/api/modules/Renderer.Navigation/#returns_2","title":"Returns","text":"

void

"},{"location":"extensions/api/modules/Renderer.Navigation/#hideentitydetails","title":"hideEntityDetails","text":"

\u25b8 hideEntityDetails(): void

"},{"location":"extensions/api/modules/Renderer.Navigation/#returns_3","title":"Returns","text":"

void

"},{"location":"extensions/api/modules/Renderer.Navigation/#isactiveroute","title":"isActiveRoute","text":"

\u25b8 isActiveRoute(route): boolean

"},{"location":"extensions/api/modules/Renderer.Navigation/#parameters_2","title":"Parameters","text":"Name Type route string | RouteProps<string, {}> | string[]"},{"location":"extensions/api/modules/Renderer.Navigation/#returns_4","title":"Returns","text":"

boolean

"},{"location":"extensions/api/modules/Renderer.Navigation/#navigate","title":"navigate","text":"

\u25b8 navigate(location): void

"},{"location":"extensions/api/modules/Renderer.Navigation/#parameters_3","title":"Parameters","text":"Name Type location LocationDescriptor<unknown>"},{"location":"extensions/api/modules/Renderer.Navigation/#returns_5","title":"Returns","text":"

void

"},{"location":"extensions/api/modules/Renderer.Navigation/#showdetails","title":"showDetails","text":"

\u25b8 showDetails(selfLink, resetSelected?): void

Default

resetSelected true\n
"},{"location":"extensions/api/modules/Renderer.Navigation/#parameters_4","title":"Parameters","text":"Name Type Description selfLink undefined | string The Kube selflink to show details for resetSelected? boolean If true then will reset the selected kube object (which object is highlighted generally)"},{"location":"extensions/api/modules/Renderer.Navigation/#returns_6","title":"Returns","text":"

void

"},{"location":"extensions/api/modules/Renderer.Navigation/#showentitydetails","title":"showEntityDetails","text":"

\u25b8 showEntityDetails(id): void

"},{"location":"extensions/api/modules/Renderer.Navigation/#parameters_5","title":"Parameters","text":"Name Type id string"},{"location":"extensions/api/modules/Renderer.Navigation/#returns_7","title":"Returns","text":"

void

"},{"location":"extensions/api/modules/Renderer.Theme/","title":"Renderer.Theme","text":"

@k8slens/extensions / Exports / Renderer / Theme

"},{"location":"extensions/api/modules/Renderer.Theme/#namespace-theme","title":"Namespace: Theme","text":"

Renderer.Theme

"},{"location":"extensions/api/modules/Renderer.Theme/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Renderer.Theme/#interfaces","title":"Interfaces","text":"
  • LensTheme
"},{"location":"extensions/api/modules/Renderer.Theme/#variables","title":"Variables","text":"
  • activeTheme
"},{"location":"extensions/api/modules/Renderer.Theme/#functions","title":"Functions","text":"
  • getActiveTheme
"},{"location":"extensions/api/modules/Renderer.Theme/#variables_1","title":"Variables","text":""},{"location":"extensions/api/modules/Renderer.Theme/#activetheme","title":"activeTheme","text":"

\u2022 Const activeTheme: IComputedValue

"},{"location":"extensions/api/modules/Renderer.Theme/#functions_1","title":"Functions","text":""},{"location":"extensions/api/modules/Renderer.Theme/#getactivetheme","title":"getActiveTheme","text":"

\u25b8 getActiveTheme(): ReadonlyObjectDeep

Deprecated

This hides the reactivity of active theme, use activeTheme instead

"},{"location":"extensions/api/modules/Renderer.Theme/#returns","title":"Returns","text":"

ReadonlyObjectDeep

"},{"location":"extensions/api/modules/Renderer/","title":"Renderer","text":"

@k8slens/extensions / Exports / Renderer

"},{"location":"extensions/api/modules/Renderer/#namespace-renderer","title":"Namespace: Renderer","text":""},{"location":"extensions/api/modules/Renderer/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Renderer/#namespaces","title":"Namespaces","text":"
  • Catalog
  • Component
  • K8sApi
  • Navigation
  • Theme
"},{"location":"extensions/api/modules/Renderer/#classes","title":"Classes","text":"
  • Ipc
  • LensExtension
"},{"location":"extensions/capabilities/common-capabilities/","title":"Common Capabilities","text":"

Here we will discuss common and important building blocks for your extensions, and explain how you can use them. Almost all extensions use some of these functionalities.

"},{"location":"extensions/capabilities/common-capabilities/#main-extension","title":"Main Extension","text":"

The main extension runs in the background. It adds app menu items to the Lens UI. In order to see logs from this extension, you need to start Lens from the command line.

"},{"location":"extensions/capabilities/common-capabilities/#activate","title":"Activate","text":"

This extension can register a custom callback that is executed when an extension is activated (started).

import { Main } from \"@k8slens/extensions\"\n\nexport default class ExampleMainExtension extends Main.LensExtension {\nasync onActivate() {\nconsole.log(\"hello world\")\n}\n}\n
"},{"location":"extensions/capabilities/common-capabilities/#deactivate","title":"Deactivate","text":"

This extension can register a custom callback that is executed when an extension is deactivated (stopped).

import { Main } from \"@k8slens/extensions\"\n\nexport default class ExampleMainExtension extends Main.LensExtension {\nasync onDeactivate() {\nconsole.log(\"bye bye\")\n}\n}\n
"},{"location":"extensions/capabilities/common-capabilities/#menus","title":"Menus","text":"

This extension can register custom app and tray menus that will be displayed on OS native menus.

Example:

import { Main } from \"@k8slens/extensions\"\n\nexport default class ExampleMainExtension extends Main.LensExtension {\nappMenus = [\n{\nparentId: \"help\",\nlabel: \"Example item\",\nclick() {\nMain.Navigation.navigate(\"https://k8slens.dev\");\n}\n}\n]\n\ntrayMenus = [\n{\nlabel: \"My links\",\nsubmenu: [\n{\nlabel: \"Lens\",\nclick() {\nMain.Navigation.navigate(\"https://k8slens.dev\");\n}\n},\n{\ntype: \"separator\"\n},\n{\nlabel: \"Lens Github\",\nclick() {\nMain.Navigation.navigate(\"https://github.com/lensapp/lens\");\n}\n}\n]\n}\n]\n}\n
"},{"location":"extensions/capabilities/common-capabilities/#renderer-extension","title":"Renderer Extension","text":"

The renderer extension runs in a browser context, and is visible in Lens's main window. In order to see logs from this extension you need to check them via View > Toggle Developer Tools > Console.

"},{"location":"extensions/capabilities/common-capabilities/#activate_1","title":"Activate","text":"

This extension can register a custom callback that is executed when an extension is activated (started).

import { Renderer } from \"@k8slens/extensions\"\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nasync onActivate() {\nconsole.log(\"hello world\")\n}\n}\n
"},{"location":"extensions/capabilities/common-capabilities/#deactivate_1","title":"Deactivate","text":"

This extension can register a custom callback that is executed when an extension is deactivated (stopped).

import { Renderer } from \"@k8slens/extensions\"\n\nexport default class ExampleMainExtension extends Renderer.LensExtension {\nasync onDeactivate() {\nconsole.log(\"bye bye\")\n}\n}\n
"},{"location":"extensions/capabilities/common-capabilities/#global-pages","title":"Global Pages","text":"

This extension can register custom global pages (views) to Lens's main window. The global page is a full-screen page that hides all other content from a window.

import React from \"react\"\nimport { Renderer } from \"@k8slens/extensions\"\nimport { ExamplePage } from \"./src/example-page\"\n\nconst {\nComponent: {\nIcon,\n}\n} = Renderer;\n\nexport default class ExampleRendererExtension extends Renderer.LensExtension {\nglobalPages = [\n{\nid: \"example\",\ncomponents: {\nPage: ExamplePage,\n}\n}\n]\n\nglobalPageMenus = [\n{\ntitle: \"Example page\", // used in icon's tooltip\ntarget: { pageId: \"example\" }\ncomponents: {\nIcon: () => <Icon material=\"arrow\"/>,\n}\n}\n]\n}\n
"},{"location":"extensions/capabilities/common-capabilities/#app-preferences","title":"App Preferences","text":"

This extension can register custom app preferences. It is responsible for storing a state for custom preferences.

import React from \"react\"\nimport { Renderer } from \"@k8slens/extensions\"\nimport { myCustomPreferencesStore } from \"./src/my-custom-preferences-store\"\nimport { MyCustomPreferenceHint, MyCustomPreferenceInput } from \"./src/my-custom-preference\"\n\n\nexport default class ExampleRendererExtension extends Renderer.LensExtension {\nappPreferences = [\n{\ntitle: \"My Custom Preference\",\ncomponents: {\nHint: () => <MyCustomPreferenceHint/>,\nInput: () => <MyCustomPreferenceInput store={myCustomPreferencesStore}/>\n}\n}\n]\n}\n
"},{"location":"extensions/capabilities/common-capabilities/#cluster-pages","title":"Cluster Pages","text":"

This extension can register custom cluster pages. These pages are visible in a cluster menu when a cluster is opened.

import React from \"react\"\nimport { Renderer } from \"@k8slens/extensions\";\nimport { ExampleIcon, ExamplePage } from \"./src/page\"\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nclusterPages = [\n{\nid: \"extension-example\", // optional\nexact: true, // optional\ncomponents: {\nPage: () => <ExamplePage extension={this}/>,\n}\n}\n]\n\nclusterPageMenus = [\n{\nurl: \"/extension-example\", // optional\ntitle: \"Example Extension\",\ncomponents: {\nIcon: ExampleIcon,\n}\n}\n]\n}\n
"},{"location":"extensions/capabilities/common-capabilities/#top-bar-items","title":"Top Bar Items","text":"

This extension can register custom components to a top bar area.

import React from \"react\";\nimport { Renderer } from \"@k8slens/extensions\";\n\nconst {\nComponent: {\nIcon,\n}\n} = Renderer;\n\nexport default class ExampleExtension extends Renderer.LensExtension {\ntopBarItems = [\n{\ncomponents: {\nItem: () => (\n<Icon material=\"favorite\" onClick={() => this.navigate(\"/example-page\" />\n)\n}\n}\n]\n}\n
"},{"location":"extensions/capabilities/common-capabilities/#status-bar-items","title":"Status Bar Items","text":"

This extension can register custom icons and text to a status bar area.

import React from \"react\";\nimport { Renderer } from \"@k8slens/extensions\";\n\nconst {\nComponent: {\nIcon,\n}\n} = Renderer;\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nstatusBarItems = [\n{\ncomponents: {\nItem: () => (\n<div className=\"flex align-center gaps hover-highlight\" onClick={() => this.navigate(\"/example-page\")} >\n<Icon material=\"favorite\" />\n</div>\n)\n}\n}\n]\n}\n
"},{"location":"extensions/capabilities/common-capabilities/#kubernetes-workloads-overview-items","title":"Kubernetes Workloads Overview Items","text":"

This extension can register custom workloads overview items.

import React from \"react\"\nimport { Renderer } from \"@k8slens/extensions\";\nimport { CustomWorkloadsOverviewItem } from \"./src/custom-workloads-overview-item\"\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nkubeWorkloadsOverviewItems = [\n{\ncomponents: {\nDetails: () => <CustomWorkloadsOverviewItem />\n}\n}\n]\n}\n
"},{"location":"extensions/capabilities/common-capabilities/#kubernetes-object-menu-items","title":"Kubernetes Object Menu Items","text":"

This extension can register custom menu items (actions) for specified Kubernetes kinds/apiVersions.

import React from \"react\"\nimport { Renderer } from \"@k8slens/extensions\";\nimport { CustomMenuItem, CustomMenuItemProps } from \"./src/custom-menu-item\"\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nkubeObjectMenuItems = [\n{\nkind: \"Node\",\napiVersions: [\"v1\"],\ncomponents: {\nMenuItem: (props: CustomMenuItemProps) => <CustomMenuItem {...props} />\n}\n}\n]\n}\n
"},{"location":"extensions/capabilities/common-capabilities/#kubernetes-object-details","title":"Kubernetes Object Details","text":"

This extension can register custom details (content) for specified Kubernetes kinds/apiVersions.

import React from \"react\"\nimport { Renderer } from \"@k8slens/extensions\";\nimport { CustomKindDetails, CustomKindDetailsProps } from \"./src/custom-kind-details\"\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nkubeObjectDetailItems = [\n{\nkind: \"CustomKind\",\napiVersions: [\"custom.acme.org/v1\"],\ncomponents: {\nDetails: (props: CustomKindDetailsProps) => <CustomKindDetails {...props} />\n}\n}\n]\n}\n
"},{"location":"extensions/capabilities/styling/","title":"Styling an Extension","text":"

Lens provides a set of global styles and UI components that can be used by any extension to preserve the look and feel of the application.

"},{"location":"extensions/capabilities/styling/#layout","title":"Layout","text":"

For layout tasks, Lens uses the flex.box library which provides helpful class names to specify some of the flexbox properties. For example, consider the following HTML and its associated CSS properties:

<div className=\"flex column align-center\"></div>\n
div {\ndisplay: flex;\nflex-direction: column;\nalign-items: center;\n}\n

However, you are free to use any styling technique or framework you like, including Emotion or even plain CSS.

"},{"location":"extensions/capabilities/styling/#layout-variables","title":"Layout Variables","text":"

There is a set of CSS variables available for for basic layout needs. They are located inside :root and are defined in app.scss:

--unit: 8px;\n--padding: var(--unit);\n--margin: var(--unit);\n--border-radius: 3px;\n

These variables are intended to set consistent margins and paddings across components. For example:

.status {\npadding-left: calc(var(--padding) * 2);\nborder-radius: var(--border-radius);\n}\n
"},{"location":"extensions/capabilities/styling/#themes","title":"Themes","text":"

Lens uses two built-in themes defined in the themes directory \u2013 one light and one dark.

"},{"location":"extensions/capabilities/styling/#theme-variables","title":"Theme Variables","text":"

When Lens is loaded, it transforms the selected theme's json file into a list of CSS Custom Properties (CSS Variables). This list then gets injected into the :root element so that any of the down-level components can use them.

When the user changes the theme, the above process is repeated, and new CSS variables appear, replacing the previous ones.

If you want to preserve Lens's native look and feel, with respect to the lightness or darkness of your extension, you can use the provided variables and built-in Lens components such as Button, Select, Table, and so on.

There is a set of CSS variables available for extensions to use for theming. They are all located inside :root and are defined in app.scss:

--font-main: 'Roboto', 'Helvetica', 'Arial', sans-serif;\n--font-monospace: Lucida Console, Monaco, Consolas, monospace;\n--font-size-small: calc(1.5 * var(--unit));\n--font-size: calc(1.75 * var(--unit));\n--font-size-big: calc(2 * var(--unit));\n--font-weight-thin: 300;\n--font-weight-normal: 400;\n--font-weight-bold: 500;\n

as well as in the theme modules:

--blue: #3d90ce;\n--magenta: #c93dce;\n--golden: #ffc63d;\n--halfGray: #87909c80;\n--primary: #3d90ce;\n--textColorPrimary: #555555;\n--textColorSecondary: #51575d;\n--textColorAccent: #333333;\n--borderColor: #c9cfd3;\n--borderFaintColor: #dfdfdf;\n--mainBackground: #f1f1f1;\n--contentColor: #ffffff;\n--layoutBackground: #e8e8e8;\n--layoutTabsBackground: #f8f8f8;\n--layoutTabsActiveColor: #333333;\n--layoutTabsLineColor: #87909c80;\n...\n

These variables can be used in the following form: var(--magenta). For example:

.status {\nfont-size: var(--font-size-small);\nbackground-color: var(--colorSuccess);\n}\n
"},{"location":"extensions/capabilities/styling/#theme-switching","title":"Theme Switching","text":"

When the light theme is active, the <body> element gets a \"theme-light\" class, or: <body class=\"theme-light\">. If the class isn't there, the theme defaults to dark. The active theme can be changed in the Preferences page:

There is a way of detect active theme and its changes in JS. MobX observer function/decorator can be used for this purpose.

import React from \"react\"\nimport { observer } from \"mobx-react\"\nimport { Renderer } from \"@k8slens/extensions\";\n\n@observer\nexport class SupportPage extends React.Component {\nrender() {\nreturn (\n<div className=\"SupportPage\">\n<h1>Active theme is {Renderer.Theme.getActiveTheme().name}</h1>\n</div>\n);\n}\n}\n

Theme entity from @k8slens/extensions provides active theme object and @observer decorator makes component reactive - so it will rerender each time any of the observables (active theme in our case) will be changed.

Working example provided in Styling with Emotion sample extension.

"},{"location":"extensions/capabilities/styling/#injected-styles","title":"Injected Styles","text":"

Every extension is affected by the list of default global styles defined in app.scss. These are basic browser resets and element styles, including:

  • setting the box-sizing property for every element
  • default text and background colors
  • default font sizes
  • basic heading (h1, h2, etc) formatting
  • custom scrollbar styling

Extensions may overwrite these defaults if needed. They have low CSS specificity, so overriding them should be fairly easy.

"},{"location":"extensions/capabilities/styling/#css-in-js","title":"CSS-in-JS","text":"

If an extension uses a system like Emotion to work with styles, it can use CSS variables as follows:

const Container = styled.div(() => ({\nbackgroundColor: 'var(--mainBackground)'\n}));\n
"},{"location":"extensions/capabilities/styling/#examples","title":"Examples","text":"

You can explore samples for each styling technique that you can use for extensions:

  • Styling with Sass
  • Styling with Emotion
  • Styling with CSS Modules
"},{"location":"extensions/get-started/anatomy/","title":"Extension Anatomy","text":"

In the previous section you learned how to create your first extension. In this section you will learn how this extension works under the hood.

The Hello World sample extension does three things:

  • Implements onActivate() and outputs a message to the console.
  • Implements onDeactivate() and outputs a message to the console.
  • Registers ClusterPage so that the page is visible in the left-side menu of the cluster dashboard.

Let's take a closer look at our Hello World sample's source code and see how these three things are achieved.

"},{"location":"extensions/get-started/anatomy/#extension-file-structure","title":"Extension File Structure","text":"
.\n\u251c\u2500\u2500 .gitignore          // Ignore build output and node_modules\n\u251c\u2500\u2500 Makefile            // Config for build tasks that compiles the extension\n\u251c\u2500\u2500 README.md           // Readable description of your extension's functionality\n\u251c\u2500\u2500 src\n\u2502   \u2514\u2500\u2500 page.tsx         // Extension's additional source code\n\u251c\u2500\u2500 main.ts              // Source code for extension's main entrypoint\n\u251c\u2500\u2500 package.json         // Extension manifest and dependencies\n\u251c\u2500\u2500 renderer.tsx         // Source code for extension's renderer entrypoint\n\u251c\u2500\u2500 tsconfig.json        // TypeScript configuration\n\u251c\u2500\u2500 webpack.config.js    // Webpack configuration\n

The extension directory contains the extension's entry files and a few configuration files. Three files: package.json, main.ts and renderer.tsx are essential to understanding the Hello World sample extension. We'll look at those first.

"},{"location":"extensions/get-started/anatomy/#extension-manifest","title":"Extension Manifest","text":"

Each Lens extension must have a package.json file. It contains a mix of Node.js fields, including scripts and dependencies, and Lens-specific fields such as publisher and contributes. Some of the most-important fields include:

  • name and publisher: Lens uses @<publisher>/<name> as a unique ID for the extension. For example, the Hello World sample has the ID @lensapp-samples/helloworld-sample. Lens uses this ID to uniquely identify your extension.
  • main: the extension's entry point run in main process.
  • renderer: the extension's entry point run in renderer process.
  • engines.lens: the minimum version of Lens API that the extension depends upon. We only support the ^ range, which is also optional to specify, and only major and minor version numbers. Meaning that ^5.4 and 5.4 both mean the same thing, and the patch version in 5.4.2 is ignored.
{\n\"name\": \"helloworld-sample\",\n\"publisher\": \"lens-samples\",\n\"version\": \"0.0.1\",\n\"description\": \"Lens helloworld-sample\",\n\"license\": \"MIT\",\n\"homepage\": \"https://github.com/lensapp/lens-extension-samples\",\n\"engines\": {\n\"node\": \"^16.14.2\",\n\"lens\": \"5.4\"\n},\n\"main\": \"dist/main.js\",\n\"renderer\": \"dist/renderer.js\",\n\"scripts\": {\n\"build\": \"webpack --config webpack.config.js\",\n\"dev\": \"npm run build --watch\"\n},\n\"dependencies\": {\n\"react-open-doodles\": \"^1.0.5\"\n},\n\"devDependencies\": {\n\"@k8slens/extensions\": \"^5.4.6\",\n\"ts-loader\": \"^8.0.4\",\n\"typescript\": \"^4.5.5\",\n\"@types/react\": \"^17.0.44\",\n\"@types/node\": \"^16.14.2\",\n\"webpack\": \"^4.44.2\",\n\"webpack-cli\": \"^3.3.11\"\n}\n}\n
"},{"location":"extensions/get-started/anatomy/#webpack-configuration","title":"Webpack configuration","text":"

The following webpack externals are provided by Lens and must be used (when available) to make sure that the versions used are in sync.

Package webpack external syntax Lens versions Available in Main Available in Renderer mobx var global.Mobx >5.0.0 \u2705 \u2705 mobx-react var global.MobxReact >5.0.0 \u274c \u2705 react var global.React >5.0.0 \u274c \u2705 react-router var global.ReactRouter >5.0.0 \u274c \u2705 react-router-dom var global.ReactRouterDom >5.0.0 \u274c \u2705 react-dom var global.ReactDOM >5.5.0 \u274c \u2705

What is exported is the whole of the packages as a * import (within typescript).

For example, the following is how you would specify these within your webpack configuration files.

{\n...\n\"externals\": [\n...\n{\n\"mobx\": \"var global.Mobx\"\n\"mobx-react\": \"var global.MobxReact\"\n\"react\": \"var global.React\"\n\"react-router\": \"var global.ReactRouter\"\n\"react-router-dom\": \"var global.ReactRouterDom\"\n\"react-dom\": \"var global.ReactDOM\"\n}\n]\n}\n
"},{"location":"extensions/get-started/anatomy/#extension-entry-files","title":"Extension Entry Files","text":"

Lens extensions can have two separate entry files. One file is used in the main process of the Lens application and the other is used in the renderer process. The main entry file exports the class that extends LensMainExtension, and the renderer entry file exports the class that extends LensRendererExtension.

Both extension classes have onActivate and onDeactivate methods. The onActivate method is executed when your extension is activated. If you need to initialize something in your extension, this is where such an operation should occur. The onDeactivate method gives you a chance to clean up before your extension becomes deactivated. For extensions where explicit cleanup is not required, you don't need to override this method. However, if an extension needs to perform an operation when Lens is shutting down (or if the extension is disabled or uninstalled), this is the method where such an operation should occur.

The Hello World sample extension does not do anything on the main process, so we'll focus on the renderer process, instead. On the renderer entry point, the Hello World sample extension defines the Cluster Page object. The Cluster Page object registers the /extension-example path, and this path renders the ExamplePage React component. It also registers the MenuItem component that displays the ExampleIcon React component and the \"Hello World\" text in the left-side menu of the cluster dashboard. These React components are defined in the additional ./src/page.tsx file.

import { Renderer } from \"@k8slens/extensions\";\nimport { ExampleIcon, ExamplePage } from \"./page\";\nimport React from \"react\";\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nclusterPages = [\n{\nid: \"extension-example\",\ncomponents: {\nPage: () => <ExamplePage extension={this} />,\n},\n},\n];\n}\n

The Hello World sample extension uses the Cluster Page capability, which is just one of the Lens extension API's capabilities. The Common Capabilities page will help you home in on the right capabilities to use with your own extensions.

"},{"location":"extensions/get-started/overview/","title":"Extension Development Overview","text":"

This is a general overview to how the development of an extension will proceed. For building extensions there will be a few things that you should have installed, and some other things that might be of help.

"},{"location":"extensions/get-started/overview/#required","title":"Required:","text":"
  • Node.js
  • Git
  • Some sort of text editor \u2013 we recommend VSCode
  • We use Webpack for compilation. All extension need to be at least compatible with a webpack system.
"},{"location":"extensions/get-started/overview/#recommended","title":"Recommended:","text":"

All Lens extensions are javascript packages. We recommend that you program in Typescript because it catches many common errors.

Lens is a standard Electron application with both main and renderer processes. An extension is made up of two parts, one for each of Lens's core processes. When an extension is loaded, each part is first loaded and issues a notification that it has been loaded. From there, the extension can start doing is work.

Lens uses React as its UI framework and provides some of Lens's own components for reuse with extensions. An extension is responsible for the lifetime of any resources it spins up. If an extension's main part starts new processes they all must be stopped and cleaned up when the extension is deactivated or unloaded.

See Your First Extension to get started.

"},{"location":"extensions/get-started/wrapping-up/","title":"Wrapping Up","text":"

In Your First Extension, you learned how to create and run an extension. In Extension Anatomy, you learned in detail how a basic extension works. This is just a glimpse into what can be created with Lens extensions. Below are some suggested routes for learning more.

"},{"location":"extensions/get-started/wrapping-up/#extension-capabilities","title":"Extension Capabilities","text":"

In this section, you'll find information on common extension capabilities, styling information, and a color reference guide. Determine whether your idea for an extension is doable and get ideas for new extensions by reading through the Common Capabilities page.

"},{"location":"extensions/get-started/wrapping-up/#guides-and-samples","title":"Guides and Samples","text":"

Here you'll find a collection of sample extensions that you can use as a base to work from. Some of these samples include a detailed guide that explains the source code. You can find all samples and guides in the lens-extension-samples repository.

"},{"location":"extensions/get-started/wrapping-up/#testing-and-publishing","title":"Testing and Publishing","text":"

In this section, you can learn:

  • How to add integration tests to your extension
  • How to publish your extension
"},{"location":"extensions/get-started/your-first-extension/","title":"Your First Extension","text":"

We recommend to always use Yeoman generator for Lens Extension to start new extension project. Read the generator guide here.

If you want to setup the project manually, please continue reading.

"},{"location":"extensions/get-started/your-first-extension/#first-extension","title":"First Extension","text":"

In this topic, you'll learn the basics of building extensions by creating an extension that adds a \"Hello World\" page to a cluster menu.

"},{"location":"extensions/get-started/your-first-extension/#install-the-extension","title":"Install the Extension","text":"

To install the extension, clone the Lens Extension samples repository to your local machine:

git clone https://github.com/lensapp/lens-extension-samples.git\n

Next you need to create a symlink. A symlink connects the directory that Lens will monitor for user-installed extensions to the sample extension. In this case the sample extension is helloworld-sample.

"},{"location":"extensions/get-started/your-first-extension/#linux-macos","title":"Linux & macOS","text":"
mkdir -p ~/.k8slens/extensions\ncd ~/.k8slens/extensions\nln -s lens-extension-samples/helloworld-sample helloworld-sample\n
"},{"location":"extensions/get-started/your-first-extension/#windows","title":"Windows","text":"

Create the directory that Lens will monitor for user-installed extensions:

mkdir C:\\Users\\<user>\\.k8slens\\extensions -force\ncd C:\\Users\\<user>\\.k8slens\\extensions\n

If you have administrator rights, you can create symlink to the sample extension \u2013 in this case helloworld-sample:

cmd /c mklink /D helloworld-sample lens-extension-samples\\helloworld-sample\n

Without administrator rights, you need to copy the extensions sample directory into C:\\Users\\<user>\\.k8slens\\extensions:

Copy-Item 'lens-extension-samples\\helloworld-sample' 'C:\\Users\\<user>\\.k8slens\\extensions\\helloworld-sample'\n
"},{"location":"extensions/get-started/your-first-extension/#build-the-extension","title":"Build the Extension","text":"

To build the extension you can use make or run the npm commands manually:

cd <lens-extension-samples directory>/helloworld-sample\nmake build\n

To run the npm commands, enter:

cd <lens-extension-samples directory>/helloworld-sample\nnpm install\nnpm run build\n

Optionally, automatically rebuild the extension by watching for changes to the source code. To do so, enter:

cd <lens-extension-samples directory>/helloworld-sample\nnpm run dev\n

You must restart Lens for the extension to load. After this initial restart, reload Lens and it will automatically pick up changes any time the extension rebuilds.

With Lens running, either connect to an existing cluster or create a new one - refer to the latest Lens Documentation for details on how to add a cluster in Lens IDE. You will see the \"Hello World\" page in the left-side cluster menu.

"},{"location":"extensions/get-started/your-first-extension/#develop-the-extension","title":"Develop the Extension","text":"

Finally, you'll make a change to the message that our Hello World sample extension displays:

  1. Navigate to <lens-extension-samples directory>/helloworld-sample.
  2. In page.tsx, change the message from HelloWorld! to Hello Lens Extensions.
  3. Rebuild the extension. If you used npm run dev, the extension will rebuild automatically.
  4. Reload the Lens window.
  5. Click on the Hello World page.
  6. The updated message will appear.
"},{"location":"extensions/get-started/your-first-extension/#next-steps","title":"Next Steps","text":"

In the next topic, we'll take a closer look at the source code of our Hello World sample.

You can find the source code for this tutorial at: lensapp/lens-extension-samples. Extension Guides contains additional samples.

"},{"location":"extensions/guides/","title":"Extension Guides","text":"

This section explains how to use specific Lens Extension APIs. It includes detailed guides and code samples. For introductory information about the Lens Extension API, please see Your First Extension.

Each guide or code sample includes the following:

  • Clearly commented source code.
  • Instructions for running the sample extension.
  • An image showing the sample extension's appearance and usage.
  • A listing of the Extension API being used.
  • An explanation of the concepts relevant to the Extension.
"},{"location":"extensions/guides/#guides","title":"Guides","text":"Guide APIs Generate new extension project Main process extension Main.LensExtension Renderer process extension Renderer.LensExtension Resource stack (cluster feature) Extending KubernetesCluster) Stores Components KubeObjectListLayout Working with mobx Protocol Handlers Sending Data between main and renderer Catalog Entities and Categories"},{"location":"extensions/guides/#samples","title":"Samples","text":"Sample APIs hello-world LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps styling-css-modules-sample LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps styling-emotion-sample LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps styling-sass-sample LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps custom-resource-page LensRendererExtension Renderer.K8sApi.KubeApi Renderer.K8sApi.KubeObjectStore Renderer.Component.KubeObjectListLayout Renderer.Component.KubeObjectDetailsProps Renderer.Component.IconProps"},{"location":"extensions/guides/anatomy/","title":"Anatomy","text":""},{"location":"extensions/guides/anatomy/#wip","title":"WIP","text":""},{"location":"extensions/guides/catalog/","title":"Catalog (WIP)","text":"

This guide is a brief overview about how the catalog works within Lens. The catalog should be thought of as the single source of truth about data within Lens.

The data flow is unidirectional, it only flows from the main side to the renderer side. All data is public within the catalog.

"},{"location":"extensions/guides/catalog/#categories","title":"Categories","text":"

A category is the declaration to the catalog of a specific kind of entity. It declares the currently supported versions of that kind of entity but providing the constructors for the entity classes.

To declare a new category class you must create a new class that extends Common.Catalog.CatalogCategory and implement all of the abstract fields.

The categories provided by Lens itself have the following names:

  • KubernetesClusters
  • WebLinks
  • General

To register a category, call the Main.Catalog.catalogCategories.add() and Renderer.Catalog.catalogCategories.add() with instances of your class.

"},{"location":"extensions/guides/catalog/#custom-category-views","title":"Custom Category Views","text":"

By default when a specific category is selected in the catalog page a list of entities of the group and kind that the category has registered. It is possible to register custom views for specific categories by registering them on your Renderer.LensExtension class.

A registration takes the form of a Common.Types.CustomCategoryViewRegistration

For example:

import { Renderer, Common } from \"@k8slens/extensions\";\n\nfunction MyKubernetesClusterView({\ncategory,\n}: Common.Types.CustomCategoryViewProps) {\nreturn <div>My view: {category.getId()}</div>;\n}\n\nexport default class extends Renderer.LensExtension {\ncustomCategoryViews = [\n{\ngroup: \"entity.k8slens.dev\",\nkind: \"KubernetesCluster\",\npriority: 10,\ncomponents: {\nView: MyKubernetesClusterView,\n},\n},\n];\n}\n

Will register a new view for the KubernetesCluster category, and because the priority is < 50 it will be displayed above the default list view.

The default list view has a priority of 50 and and custom views with priority (defaulting to 50) >= 50 will be displayed afterwards.

"},{"location":"extensions/guides/catalog/#styling-custom-views","title":"Styling Custom Views","text":"

By default, custom view blocks are styled with Flexbox. Some details comes from this.

  • To set fixed height of a custom block, use max-height css rule.
  • To set flexible height, use height.
  • Otherwise, custom view will have height of it's contents.
"},{"location":"extensions/guides/catalog/#entities","title":"Entities","text":"

An entity is the data within the catalog. All entities are typed and the class instances will be recreated on the renderer side by the catalog and the category registrations.

"},{"location":"extensions/guides/components/","title":"Components","text":""},{"location":"extensions/guides/components/#wip","title":"WIP","text":""},{"location":"extensions/guides/extending-kubernetes-cluster/","title":"Extending KubernetesCluster","text":"

Extension can specify it's own subclass of Common.Catalog.KubernetesCluster. Extension can also specify a new Category for it in the Catalog.

"},{"location":"extensions/guides/extending-kubernetes-cluster/#extending-commoncatalogkubernetescluster","title":"Extending Common.Catalog.KubernetesCluster","text":"
import { Common } from \"@k8slens/extensions\";\n\n// The kind must be different from KubernetesCluster's kind\nexport const kind = \"ManagedDevCluster\";\n\nexport class ManagedDevCluster extends Common.Catalog.KubernetesCluster {\npublic static readonly kind = kind;\n\npublic readonly kind = kind;\n}\n
"},{"location":"extensions/guides/extending-kubernetes-cluster/#extending-commoncatalogcatalogcategory","title":"Extending Common.Catalog.CatalogCategory","text":"

These custom Catalog entities can be added a new Category in the Catalog.

import { Common } from \"@k8slens/extensions\";\nimport { kind, ManagedDevCluster } from \"../entities/ManagedDevCluster\";\n\nclass ManagedDevClusterCategory extends Common.Catalog.CatalogCategory {\npublic readonly apiVersion = \"catalog.k8slens.dev/v1alpha1\";\npublic readonly kind = \"CatalogCategory\";\npublic metadata = {\nname: \"Managed Dev Clusters\",\nicon: \"\"\n};\npublic spec: Common.Catalog.CatalogCategorySpec = {\ngroup: \"entity.k8slens.dev\",\nversions: [\n{\nname: \"v1alpha1\",\nentityClass: ManagedDevCluster as any,\n},\n],\nnames: {\nkind\n},\n};\n}\n\nexport { ManagedDevClusterCategory };\nexport type { ManagedDevClusterCategory as ManagedDevClusterCategoryType };\n

The category needs to be registered in the onActivate() method both in main and renderer

// in main's on onActivate\nMain.Catalog.catalogCategories.add(new ManagedDevClusterCategory());\n
// in renderer's on onActivate\nRenderer.Catalog.catalogCategories.add(new ManagedDevClusterCategory());\n

You can then add the entities to the Catalog as a new source:

this.addCatalogSource(\"managedDevClusters\", this.managedDevClusters);\n
"},{"location":"extensions/guides/generator/","title":"Lens Extension Generator","text":"

The Lens Extension Generator creates a directory with the necessary files for developing an extension.

"},{"location":"extensions/guides/generator/#installing-and-getting-started-with-the-generator","title":"Installing and Getting Started with the Generator","text":"

To begin, install Yeoman and the Lens Extension Generator with the following command:

npm install -g yo generator-lens-ext\n

Run the generator by entering the following command: yo lens-ext.

Answer the following questions:

# ? What type of extension do you want to create? New Extension (TypeScript)\n# ? What's the name of your extension? my-first-lens-ext\n# ? What's the description of your extension? My hello world extension\n# ? What's your extension's publisher name? @my-org/my-first-lens-ext\n# ? Initialize a git repository? Yes\n# ? Install dependencies after initialization? Yes\n# ? Which package manager to use? yarn\n# ? symlink created extension folder to ~/.k8slens/extensions (mac/linux) or :Users\\<user>\\.k8slens\\extensions (windows)? Yes\n

Next, you'll need to have webpack watch the my-first-lens-ext folder. Start webpack by entering:

cd my-first-lens-ext\nnpm start # start the webpack server in watch mode\n

Open Lens and you will see a Hello World item in the left-side menu under Custom Resources:

"},{"location":"extensions/guides/generator/#developing-the-extension","title":"Developing the Extension","text":"

Next, you'll try changing the way the new menu item appears in the UI. You'll change it from \"Hello World\" to \"Hello Lens\".

Open my-first-lens-ext/renderer.tsx and change the value of title from \"Hello World\" to \"Hello Lens\":

clusterPageMenus = [\n{\ntarget: { pageId: \"hello\" },\ntitle: \"Hello Lens\",\ncomponents: {\nIcon: ExampleIcon,\n},\n},\n];\n

Reload Lens and you will see that the menu item text has changed to \"Hello Lens\". To reload Lens, enter CMD+R on Mac and Ctrl+R on Windows/Linux.

"},{"location":"extensions/guides/generator/#debugging-the-extension","title":"Debugging the Extension","text":"

To debug your extension, please see our instructions on Testing Extensions.

"},{"location":"extensions/guides/generator/#next-steps","title":"Next Steps","text":"

To dive deeper, consider looking at Common Capabilities, Styling, or Extension Anatomy.

If you find problems with the Lens Extension Generator, or have feature requests, you are welcome to raise an issue. You can find the latest Lens contribution guidelines here.

The Generator source code is hosted at GitHub.

"},{"location":"extensions/guides/ipc/","title":"Inter Process Communication","text":"

A Lens Extension can utilize IPC to send information between the renderer and main processes. This is useful when wanting to communicate directly within your extension.

For example, if a user logs into a service that your extension is a facade for and main needs to know some information so that you can start syncing items to the Catalog, this would be a good way to send that information along.

IPC channels are sectioned off per extension. Meaning that each extension can only communicate with itself.

"},{"location":"extensions/guides/ipc/#types-of-communication","title":"Types of Communication","text":"

There are two flavours of communication that are provided:

  • Event based (IPC)
  • Request based (RPC)
"},{"location":"extensions/guides/ipc/#event-based-or-ipc","title":"Event Based or IPC","text":"

This is the same as an Event Emitter but is not limited to just one Javascript process. This is a good option when you need to report that something has happened but you don't need a response.

This is a fully two-way form of communication. Both main and renderer can do this sort of IPC.

"},{"location":"extensions/guides/ipc/#request-based-or-rpc","title":"Request Based or RPC","text":"

This is more like a Remote Procedure Call (RPC) or Send-Receive-Reply (SRR). With this sort of communication the caller needs to wait for the result from the other side. This is accomplished by await-ing the returned Promise<any>.

This is a unidirectional form of communication. Only renderer can initiate this kind of request, and only main can receive and respond to this kind of request.

"},{"location":"extensions/guides/ipc/#registering-ipc-handlers-and-listeners","title":"Registering IPC Handlers and Listeners","text":"

The general terminology is as follows:

  • A \"handler\" is the function that responds to a \"Request Based IPC\" event.
  • A \"listener\" is the function that is called when a \"Event Based IPC\" event is emitted.

To register either a handler or a listener, you should do something like the following:

main.ts:

import { Main } from \"@k8slens/extensions\";\nimport { IpcMain } from \"./helpers/main\";\n\nexport class ExampleExtensionMain extends Main.LensExtension {\nonActivate() {\nIpcMain.createInstance(this);\n}\n}\n

This file shows that you need to create an instance of the store to be able to use IPC. Lens will automatically clean up that store and all the handlers on deactivation and uninstall.

helpers/main.ts:

import { Main } from \"@k8slens/extensions\";\n\nexport class IpcMain extends Main.Ipc {\nconstructor(extension: Main.LensExtension) {\nsuper(extension);\n\nthis.listen(\"initialize\", onInitialize);\n}\n}\n\nfunction onInitialize(event: Types.IpcMainEvent, id: string) {\nconsole.log(`starting to initialize: ${id}`);\n}\n

In other files, it is not necessary to pass around any instances. You should be able to just call IpcMain.getInstance() anywhere it is needed in your extension.

renderer.ts:

import { Renderer } from \"@k8slens/extensions\";\nimport { IpcRenderer } from \"./helpers/renderer\";\n\nexport class ExampleExtensionRenderer extends Renderer.LensExtension {\nonActivate() {\nconst ipc = IpcRenderer.createInstance(this);\n\nsetTimeout(() => ipc.broadcast(\"initialize\", \"an-id\"), 5000);\n}\n}\n

It is also needed to create an instance to broadcast messages too.

helpers/renderer.ts:

import { Renderer } from \"@k8slens/extensions\";\n\nexport class IpcRenderer extends Renderer.Ipc {}\n

It is necessary to create child classes of these abstract class's in your extension before you can use them.

As this example shows: the channel names must be the same. It should also be noted that \"listeners\" and \"handlers\" are specific to either renderer or main. There is no behind the scenes transfer of these functions.

To register a \"handler\" call IpcMain.getInstance().handle(...). The cleanup of these handlers is handled by Lens itself.

The listen() methods on Main.Ipc and Renderer.Ipc return a Disposer, or more specifically, a () => void. This can be optionally called to remove the listener early.

Calling either IpcRenderer.getInstance().broadcast(...) or IpcMain.getInstance().broadcast(...) sends an event to all renderer frames and to main. Because of this, no matter where you broadcast from, all listeners in main and renderer will be notified.

"},{"location":"extensions/guides/ipc/#allowed-values","title":"Allowed Values","text":"

This IPC mechanism utilizes the Structured Clone Algorithm for serialization. This means that more types than what are JSON serializable can be used, but not all the information will be passed through.

"},{"location":"extensions/guides/ipc/#using-request-based-communication","title":"Using Request Based Communication","text":"

If you are meaning to do a request based call from renderer, you should do const res = await IpcRenderer.getInstance().invoke(<channel>, ...<args>)); instead.

"},{"location":"extensions/guides/kube-object-list-layout/","title":"KubeObjectListLayout Sample","text":"

In this guide we will learn how to list Kubernetes CRD objects on the cluster dashboard. You can see the complete source code for this guide here.

Next, we will go the implementation through in steps. To achieve our goal, we need to:

  1. Register ClusterPage and ClusterPageMenu objects
  2. List Certificate Objects on the Cluster Page
  3. Customize Details Panel
"},{"location":"extensions/guides/kube-object-list-layout/#register-clusterpage-and-clusterpagemenu-objects","title":"Register clusterPage and clusterPageMenu Objects","text":"

First thing we need to do with our extension is to register new menu item in the cluster menu and create a cluster page that is opened when clicking the menu item. We will do this in our extension class CrdSampleExtension that is derived LensRendererExtension class:

export default class CrdSampleExtension extends Renderer.LensExtension {\n}\n

To register menu item in the cluster menu we need to register PageMenuRegistration object. This object will register a menu item with \"Certificates\" text. It will also use CertificateIcon component to render an icon and navigate to cluster page that is having certificates page id.

import { Renderer } from \"@k8slens/extensions\";\n\ntype IconProps = Renderer.Component.IconProps;\n\nconst {\nComponent: {\nIcon,\n},\n} = Renderer;\n\nexport function CertificateIcon(props: IconProps) {\nreturn <Icon {...props} material=\"security\" tooltip=\"Certificates\"/>\n}\n\nexport default class CrdSampleExtension extends Renderer.LensExtension {\n\nclusterPageMenus = [\n{\ntarget: { pageId: \"certificates\" },\ntitle: \"Certificates\",\ncomponents: {\nIcon: CertificateIcon,\n}\n},\n]\n}\n

Then we need to register PageRegistration object with certificates id and define CertificatePage component to render certificates.

export default class CrdSampleExtension extends Renderer.LensExtension {\n...\n\nclusterPages = [{\nid: \"certificates\",\ncomponents: {\nPage: () => <CertificatePage extension={this} />,\nMenuIcon: CertificateIcon,\n}\n}]\n}\n
"},{"location":"extensions/guides/kube-object-list-layout/#list-certificate-objects-on-the-cluster-page","title":"List Certificate Objects on the Cluster Page","text":"

In the previous step we defined CertificatePage component to render certificates. In this step we will actually implement that. CertificatePage is a React component that will render Renderer.Component.KubeObjectListLayout component to list Certificate CRD objects.

"},{"location":"extensions/guides/kube-object-list-layout/#get-crd-objects","title":"Get CRD objects","text":"

In order to list CRD objects, we need first fetch those from Kubernetes API. Lens Extensions API provides easy mechanism to do this. We just need to define Certificate class derived from Renderer.K8sApi.KubeObject, CertificatesApiderived from Renderer.K8sApi.KubeApi and CertificatesStore derived from Renderer.K8sApi.KubeObjectStore.

Certificate class defines properties found in the CRD object:

import { Renderer } from \"@k8slens/extensions\";\n\nconst {\nK8sApi: {\nKubeObject,\nKubeObjectStore,\nKubeApi,\napiManager,\n},\n} = Renderer;\n\nexport class Certificate extends KubeObject {\nstatic kind = \"Certificate\"\nstatic namespaced = true\nstatic apiBase = \"/apis/cert-manager.io/v1alpha2/certificates\"\n\nkind: string\napiVersion: string\nmetadata: {\nname: string;\nnamespace: string;\nselfLink: string;\nuid: string;\nresourceVersion: string;\ncreationTimestamp: string;\nlabels: {\n[key: string]: string;\n};\nannotations: {\n[key: string]: string;\n};\n}\nspec: {\ndnsNames: string[];\nissuerRef: {\ngroup: string;\nkind: string;\nname: string;\n}\nsecretName: string\n}\nstatus: {\nconditions: {\nlastTransitionTime: string;\nmessage: string;\nreason: string;\nstatus: string;\ntype?: string;\n}[];\n}\n}\n

With CertificatesApi class we are able to manage Certificate objects in Kubernetes API:

export class CertificatesApi extends KubeApi<Certificate> {}\n\nexport const certificatesApi = new CertificatesApi({\nobjectConstructor: Certificate\n});\n

CertificateStore defines storage for Certificate objects

export class CertificatesStore extends KubeObjectStore<Certificate> {\napi = certificatesApi\n}\n\nexport const certificatesStore = new CertificatesStore();\n

And, finally, we register this store to Lens's API manager.

apiManager.registerStore(certificatesStore);\n
"},{"location":"extensions/guides/kube-object-list-layout/#create-certificatepage-component","title":"Create CertificatePage component","text":"

Now we have created mechanism to manage Certificate objects in Kubernetes API. Then we need to fetch those and render them in the UI.

First we define CertificatePage class that extends React.Component.

import { Renderer } from \"@k8slens/extensions\";\nimport React from \"react\";\nimport { certificatesStore } from \"../certificate-store\";\nimport { Certificate } from \"../certificate\"\n\nexport class CertificatePage extends React.Component<{ extension: Renderer.LensExtension }> {\n\n}\n

Next we will implement render method that will display certificates in a list. To do that, we just need to add Renderer.Component.KubeObjectListLayout component inside Renderer.Component.TabLayout component in render method. To define which objects the list is showing, we need to pass certificateStore object to Renderer.Component.KubeObjectListLayout in store property. Renderer.Component.KubeObjectListLayout will fetch automatically items from the given store when component is mounted. Also, we can define needed sorting callbacks and search filters for the list:

import { Renderer } from \"@k8slens/extensions\";\n\nconst {\nComponent: {\nTabLayout,\nKubeObjectListLayout,\n},\n} = Renderer;\n\nenum sortBy {\nname = \"name\",\nnamespace = \"namespace\",\nissuer = \"issuer\"\n}\n\nexport class CertificatePage extends React.Component<{ extension: LensRendererExtension }> {\n// ...\n\nrender() {\nreturn (\n<TabLayout>\n<KubeObjectListLayout\nclassName=\"Certificates\" store={certificatesStore}\nsortingCallbacks={{\n[sortBy.name]: (certificate: Certificate) => certificate.getName(),\n[sortBy.namespace]: (certificate: Certificate) => certificate.metadata.namespace,\n[sortBy.issuer]: (certificate: Certificate) => certificate.spec.issuerRef.name\n}}\nsearchFilters={[\n(certificate: Certificate) => certificate.getSearchFields()\n]}\nrenderHeaderTitle=\"Certificates\"\nrenderTableHeader={[\n{ title: \"Name\", className: \"name\", sortBy: sortBy.name },\n{ title: \"Namespace\", className: \"namespace\", sortBy: sortBy.namespace },\n{ title: \"Issuer\", className: \"issuer\", sortBy: sortBy.namespace },\n]}\nrenderTableContents={(certificate: Certificate) => [\ncertificate.getName(),\ncertificate.metadata.namespace,\ncertificate.spec.issuerRef.name\n]}\n/>\n</TabLayout>\n)\n}\n}\n
"},{"location":"extensions/guides/kube-object-list-layout/#customize-details-panel","title":"Customize Details panel","text":"

We have learned now, how to list CRD objects in a list view. Next, we will learn how to customize details panel that will be opened when the object is clicked in the list.

First, we need to register our custom component to render details for the specific Kubernetes custom resource, in our case Certificate. We will do this again in CrdSampleExtension class:

export default class CrdSampleExtension extends Renderer.LensExtension {\n//...\n\nkubeObjectDetailItems = [{\nkind: Certificate.kind,\napiVersions: [\"cert-manager.io/v1alpha2\"],\ncomponents: {\nDetails: (props: CertificateDetailsProps) => <CertificateDetails {...props} />\n}\n}]\n}\n

Here we defined that CertificateDetails component will render the resource details. So, next we need to implement that component. Lens will inject Certificate object into our component so we just need to render some information out of it. We can use Renderer.Component.DrawerItem component from Lens Extensions API to give the same look and feel as Lens is using elsewhere:

import { Renderer } from \"@k8slens/extensions\";\nimport React from \"react\";\nimport { Certificate } from \"../certificate\";\n\nconst {\nComponent: {\nKubeObjectDetailsProps,\nDrawerItem,\nBadge,\n}\n} = Renderer;\n\nexport interface CertificateDetailsProps extends KubeObjectDetailsProps<Certificate>{\n}\n\nexport class CertificateDetails extends React.Component<CertificateDetailsProps> {\n\nrender() {\nconst { object: certificate } = this.props;\nif (!certificate) return null;\nreturn (\n<div className=\"Certificate\">\n<DrawerItem name=\"Created\">\n{certificate.getAge(true, false)} ago ({certificate.metadata.creationTimestamp })\n</DrawerItem>\n<DrawerItem name=\"DNS Names\">\n{certificate.spec.dnsNames.join(\",\")}\n</DrawerItem>\n<DrawerItem name=\"Secret\">\n{certificate.spec.secretName}\n</DrawerItem>\n<DrawerItem name=\"Status\" className=\"status\" labelsOnly>\n{certificate.status.conditions.map((condition, index) => {\nconst { type, reason, message, status } = condition;\nconst kind = type || reason;\nif (!kind) return null;\nreturn (\n<Badge\nkey={kind + index} label={kind}\nclassName={\"success \"+kind.toLowerCase()}\ntooltip={message}\n/>\n);\n})}\n</DrawerItem>\n</div>\n)\n}\n}\n
"},{"location":"extensions/guides/kube-object-list-layout/#summary","title":"Summary","text":"

Like we can see above, it's very easy to add custom pages and fetch Kubernetes resources by using Extensions API. Please see the complete source code to test it out.

"},{"location":"extensions/guides/main-extension/","title":"Main Extension","text":"

The Main Extension API is the interface to Lens's main process. Lens runs in both main and renderer processes. The Main Extension API allows you to access, configure, and customize Lens data, add custom application menu items and protocol handlers, and run custom code in Lens's main process. It also provides convenient methods for navigating to built-in Lens pages and extension pages, as well as adding and removing sources of catalog entities.

"},{"location":"extensions/guides/main-extension/#mainlensextension-class","title":"Main.LensExtension Class","text":""},{"location":"extensions/guides/main-extension/#onactivate-and-ondeactivate-methods","title":"onActivate() and onDeactivate() Methods","text":"

To create a main extension simply extend the Main.LensExtension class:

import { Main } from \"@k8slens/extensions\";\n\nexport default class ExampleExtensionMain extends Main.LensExtension {\nonActivate() {\nconsole.log(\"custom main process extension code started\");\n}\n\nonDeactivate() {\nconsole.log(\"custom main process extension de-activated\");\n}\n}\n

Two methods enable you to run custom code: onActivate() and onDeactivate(). Enabling your extension calls onActivate() and disabling your extension calls onDeactivate(). You can initiate custom code by implementing onActivate(). Implementing onDeactivate() gives you the opportunity to clean up after your extension.

Disable extensions from the Lens Extensions page:

  1. Navigate to File > Extensions in the top menu bar. (On Mac, it is Lens > Extensions.)
  2. Click Disable on the extension you want to disable.

The example above logs messages when the extension is enabled and disabled. To see standard output from the main process there must be a console connected to it. Achieve this by starting Lens from the command prompt.

For more details on accessing Lens state data, please see the Stores guide.

"},{"location":"extensions/guides/main-extension/#appmenus","title":"appMenus","text":"

The Main Extension API allows you to customize the UI application menu. The following example demonstrates adding an item to the Help menu.

import { Main } from \"@k8slens/extensions\";\n\nexport default class SamplePageMainExtension extends Main.LensExtension {\nappMenus = [\n{\nparentId: \"help\",\nlabel: \"Sample\",\nclick() {\nconsole.log(\"Sample clicked\");\n},\n},\n];\n}\n

appMenus is an array of objects that satisfy the MenuRegistration interface. MenuRegistration extends Electron's MenuItemConstructorOptions interface. The properties of the appMenus array objects are defined as follows:

  • parentId is the name of the menu where your new menu item will be listed. Valid values include: \"file\", \"edit\", \"view\", and \"help\". \"lens\" is valid on Mac only.
  • label is the name of your menu item.
  • click() is called when the menu item is selected. In this example, we simply log a message. However, you would typically have this navigate to a specific page or perform another operation. Note that pages are associated with the Renderer.LensExtension class and can be defined in the process of extending it.

The following example demonstrates how an application menu can be used to navigate to such a page:

import { Main } from \"@k8slens/extensions\";\n\nexport default class SamplePageMainExtension extends Main.LensExtension {\nappMenus = [\n{\nparentId: \"help\",\nlabel: \"Sample\",\nclick: () => this.navigate(\"myGlobalPage\"),\n},\n];\n}\n

When the menu item is clicked the navigate() method looks for and displays a global page with id \"myGlobalPage\". This page would be defined in your extension's Renderer.LensExtension implementation (See Renderer.LensExtension).

"},{"location":"extensions/guides/main-extension/#traymenus","title":"trayMenus","text":"

trayMenus is an array of TrayMenuRegistration objects. Most importantly you can define a label and a click handler. Other properties are submenu, enabled, toolTip, id and type.

interface TrayMenuRegistration {\nlabel?: string;\nclick?: (menuItem: TrayMenuRegistration) => void;\nid?: string;\ntype?: \"normal\" | \"separator\" | \"submenu\";\ntoolTip?: string;\nenabled?: boolean;\nsubmenu?: TrayMenuRegistration[];\n}\n

The following example demonstrates how tray menus can be added from extension:

import { Main } from \"@k8slens/extensions\";\n\nexport default class SampleTrayMenuMainExtension extends Main.LensExtension {\ntrayMenus = [\n{\nlabel: \"menu from the extension\",\nclick: () => {\nconsole.log(\"tray menu clicked!\");\n},\n},\n];\n}\n
"},{"location":"extensions/guides/main-extension/#addcatalogsource-and-removecatalogsource-methods","title":"addCatalogSource() and removeCatalogSource() Methods","text":"

The Main.LensExtension class also provides the addCatalogSource() and removeCatalogSource() methods, for managing custom catalog items (or entities). See the Catalog documentation for full details about the catalog.

"},{"location":"extensions/guides/protocol-handlers/","title":"Lens Protocol Handlers","text":"

Lens has a file association with the lens:// protocol. This means that Lens can be opened by external programs by providing a link that has lens as its protocol. Lens provides a routing mechanism that extensions can use to register custom handlers.

"},{"location":"extensions/guides/protocol-handlers/#registering-a-protocol-handler","title":"Registering A Protocol Handler","text":"

The field protocolHandlers exists both on LensMainExtension and on LensRendererExtension. This field will be iterated through every time a lens:// request gets sent to the application. The pathSchema argument must comply with the path-to-regexp package's compileToRegex function.

Once you have registered a handler it will be called when a user opens a link on their computer. Handlers will be run in both main and renderer in parallel with no synchronization between the two processes. Furthermore, both main and renderer are routed separately. In other words, which handler is selected in either process is independent from the list of possible handlers in the other.

Example of registering a handler:

import { Main, Common } from \"@k8slens/extensions\";\n\nfunction rootHandler(params: Common.Types.ProtocolRouteParams) {\nconsole.log(\"routed to ExampleExtension\", params);\n}\n\nexport default class ExampleExtensionMain extends Main.LensExtension {\nprotocolHandlers = [\npathSchema: \"/\",\nhandler: rootHandler,\n]\n}\n

For testing the routing of URIs the open (on macOS) or xdg-open (on most linux) CLI utilities can be used. For the above handler, the following URI would be always routed to it:

open lens://extension/example-extension/\n
"},{"location":"extensions/guides/protocol-handlers/#deregistering-a-protocol-handler","title":"Deregistering A Protocol Handler","text":"

All that is needed to deregister a handler is to remove it from the array of handlers.

"},{"location":"extensions/guides/protocol-handlers/#routing-algorithm","title":"Routing Algorithm","text":"

The routing mechanism for extensions is quite straight forward. For example consider an extension example-extension which is published by the @mirantis org. If it were to register a handler with \"/display/:type\" as its corresponding link then we would match the following URI like this:

Once matched, the handler would be called with the following argument (note both \"search\" and \"pathname\" will always be defined):

{\n\"search\": {\n\"text\": \"Hello\"\n},\n\"pathname\": {\n\"type\": \"notification\"\n}\n}\n

As the diagram above shows, the search (or query) params are not considered as part of the handler resolution. If the URI had instead been lens://extension/@mirantis/example-extension/display/notification/green then a third (and optional) field will have the rest of the path. The tail field would be filled with \"/green\". If multiple pathSchema's match a given URI then the most specific handler will be called.

For example consider the following pathSchema's:

  1. \"/\"
  2. \"/display\"
  3. \"/display/:type\"
  4. \"/show/:id\"

The URI sub-path \"/display\" would be routed to #2 since it is an exact match. On the other hand, the subpath \"/display/notification\" would be routed to #3.

The URI is routed to the most specific matching pathSchema. This way the \"/\" (root) pathSchema acts as a sort of catch all or default route if no other route matches.

"},{"location":"extensions/guides/renderer-extension/","title":"Renderer Extension (WIP)","text":"

The Renderer Extension API is the interface to Lens's renderer process. Lens runs in both the main and renderer processes. The Renderer Extension API allows you to access, configure, and customize Lens data, add custom Lens UI elements, protocol handlers, and command palette commands, as well as run custom code in Lens's renderer process.

The custom Lens UI elements that you can add include:

  • Cluster pages
  • Cluster page menus
  • Global pages
  • Welcome menus
  • App preferences
  • Top bar items
  • Status bar items
  • KubeObject menu items
  • KubeObject detail items
  • KubeObject status texts
  • Kube workloads overview items

as well as catalog-related UI elements:

  • Entity settings
  • Catalog entity detail items

All UI elements are based on React components.

Finally, you can also add commands and protocol handlers:

  • Command palette commands
  • protocol handlers
"},{"location":"extensions/guides/renderer-extension/#rendererlensextension-class","title":"Renderer.LensExtension Class","text":""},{"location":"extensions/guides/renderer-extension/#onactivate-and-ondeactivate-methods","title":"onActivate() and onDeactivate() Methods","text":"

To create a renderer extension, extend the Renderer.LensExtension class:

import { Renderer } from \"@k8slens/extensions\";\n\nexport default class ExampleExtensionMain extends Renderer.LensExtension {\nonActivate() {\nconsole.log(\"custom renderer process extension code started\");\n}\n\nonDeactivate() {\nconsole.log(\"custom renderer process extension de-activated\");\n}\n}\n

Two methods enable you to run custom code: onActivate() and onDeactivate(). Enabling your extension calls onActivate() and disabling your extension calls onDeactivate(). You can initiate custom code by implementing onActivate(). Implementing onDeactivate() gives you the opportunity to clean up after your extension.

Info

Disable extensions from the Lens Extensions page:

1. Navigate to **File** > **Extensions** in the top menu bar.\n(On Mac, it is **Lens** > **Extensions**.)\n2. For the extension you want to disable, open the context menu (click on the three vertical dots) and choose **Disable**.\n

The example above logs messages when the extension is enabled and disabled.

"},{"location":"extensions/guides/renderer-extension/#clusterpages","title":"clusterPages","text":"

Cluster pages appear in the cluster dashboard. Use cluster pages to display information about or add functionality to the active cluster. It is also possible to include custom details from other clusters. Use your extension to access Kubernetes resources in the active cluster with ClusterStore.getInstance().

Add a cluster page definition to a Renderer.LensExtension subclass with the following example:

import { Renderer } from \"@k8slens/extensions\";\nimport { ExampleIcon, ExamplePage } from \"./page\";\nimport React from \"react\";\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nclusterPages = [\n{\nid: \"hello\",\ncomponents: {\nPage: () => <ExamplePage extension={this} />,\n},\n},\n];\n}\n

clusterPages is an array of objects that satisfy the PageRegistration interface. The properties of the clusterPages array objects are defined as follows:

  • id is a string that identifies the page.
  • components matches the PageComponents interface for which there is one field, Page.
  • Page is of type React.ComponentType<any>. It offers flexibility in defining the appearance and behavior of your page.

ExamplePage in the example above can be defined in page.tsx:

import { Renderer } from \"@k8slens/extensions\";\nimport React from \"react\";\n\nexport class ExamplePage extends React.Component<{\nextension: LensRendererExtension;\n}> {\nrender() {\nreturn (\n<div>\n<p>Hello world!</p>\n</div>\n);\n}\n}\n

Note that the ExamplePage class defines the extension property. This allows the ExampleExtension object to be passed in the cluster page definition in the React style. This way, ExamplePage can access all ExampleExtension subclass data.

The above example shows how to create a cluster page, but not how to make that page available to the Lens user. Use clusterPageMenus, covered in the next section, to add cluster pages to the Lens UI.

"},{"location":"extensions/guides/renderer-extension/#clusterpagemenus","title":"clusterPageMenus","text":"

clusterPageMenus allows you to add cluster page menu items to the secondary left nav, below Lens's standard cluster menus like Workloads, Custom Resources, etc.

By expanding on the above example, you can add a cluster page menu item to the ExampleExtension definition:

import { Renderer } from \"@k8slens/extensions\";\nimport { ExampleIcon, ExamplePage } from \"./page\";\nimport React from \"react\";\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nclusterPages = [\n{\nid: \"hello\",\ncomponents: {\nPage: () => <ExamplePage extension={this} />,\n},\n},\n];\n\nclusterPageMenus = [\n{\ntarget: { pageId: \"hello\" },\ntitle: \"Hello World\",\ncomponents: {\nIcon: ExampleIcon,\n},\n},\n];\n}\n

clusterPageMenus is an array of objects that satisfy the ClusterPageMenuRegistration interface. This element defines how the cluster page menu item will appear and what it will do when you click it. The properties of the clusterPageMenus array objects are defined as follows:

  • target links to the relevant cluster page using pageId.
  • pageId takes the value of the relevant cluster page's id property.
  • title sets the name of the cluster page menu item that will appear in the left side menu.
  • components is used to set an icon that appears to the left of the title text in the left side menu.

The above example creates a menu item that reads Hello World. When users click Hello World, the cluster dashboard will show the contents of Example Page.

This example requires the definition of another React-based component, ExampleIcon, which has been added to page.tsx, as follows:

import { Renderer } from \"@k8slens/extensions\";\nimport React from \"react\";\n\ntype IconProps = Renderer.Component.IconProps;\n\nconst {\nComponent: { Icon },\n} = Renderer;\n\nexport function ExampleIcon(props: IconProps) {\nreturn <Icon {...props} material=\"pages\" tooltip={\"Hi!\"} />;\n}\n\nexport class ExamplePage extends React.Component<{\nextension: Renderer.LensExtension;\n}> {\nrender() {\nreturn (\n<div>\n<p>Hello world!</p>\n</div>\n);\n}\n}\n

Lens includes various built-in components available for extension developers to use. One of these is the Renderer.Component.Icon, introduced in ExampleIcon, which you can use to access any of the icons available at Material Design. The properties that Renderer.Component.Icon uses are defined as follows:

  • material takes the name of the icon you want to use.
  • tooltip sets the text you want to appear when a user hovers over the icon.

clusterPageMenus can also be used to define sub menu items, so that you can create groups of cluster pages. The following example groups two sub menu items under one parent menu item:

import { Renderer } from \"@k8slens/extensions\";\nimport { ExampleIcon, ExamplePage } from \"./page\";\nimport React from \"react\";\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nclusterPages = [\n{\nid: \"hello\",\ncomponents: {\nPage: () => <ExamplePage extension={this} />,\n},\n},\n{\nid: \"bonjour\",\ncomponents: {\nPage: () => <ExamplePage extension={this} />,\n},\n},\n];\n\nclusterPageMenus = [\n{\nid: \"example\",\ntitle: \"Greetings\",\ncomponents: {\nIcon: ExampleIcon,\n},\n},\n{\nparentId: \"example\",\ntarget: { pageId: \"hello\" },\ntitle: \"Hello World\",\ncomponents: {\nIcon: ExampleIcon,\n},\n},\n{\nparentId: \"example\",\ntarget: { pageId: \"bonjour\" },\ntitle: \"Bonjour le monde\",\ncomponents: {\nIcon: ExampleIcon,\n},\n},\n];\n}\n

The above defines two cluster pages and three cluster page menu objects. The cluster page definitions are straightforward. The three cluster page menu objects include one parent menu item and two sub menu items. The first cluster page menu object defines the parent of a foldout submenu. Setting the id field in a cluster page menu definition implies that it is defining a foldout submenu. Also note that the target field is not specified (it is ignored if the id field is specified). This cluster page menu object specifies the title and components fields, which are used in displaying the menu item in the cluster dashboard sidebar. Initially the submenu is hidden. Activating this menu item toggles on and off the appearance of the submenu below it. The remaining two cluster page menu objects define the contents of the submenu. A cluster page menu object is defined to be a submenu item by setting the parentId field to the id of the parent of a foldout submenu, \"example\" in this case.

This is what the example could look like, including how the menu item will appear in the secondary left nav:

"},{"location":"extensions/guides/renderer-extension/#globalpages","title":"globalPages","text":"

Global pages are independent of the cluster dashboard and can fill the entire Lens UI. Their primary use is to display information and provide functionality across clusters (or catalog entities), including customized data and functionality unique to your extension.

Unlike cluster pages, users can trigger global pages even when there is no active cluster (or catalog entity).

The following example defines a Renderer.LensExtension subclass with a single global page definition:

import { Renderer } from \"@k8slens/extensions\";\nimport { HelpPage } from \"./page\";\nimport React from \"react\";\n\nexport default class HelpExtension extends Renderer.LensExtension {\nglobalPages = [\n{\nid: \"help\",\ncomponents: {\nPage: () => <HelpPage extension={this} />,\n},\n},\n];\n}\n

globalPages is an array of objects that satisfy the PageRegistration interface. The properties of the globalPages array objects are defined as follows:

  • id is a string that identifies the page.
  • components matches the PageComponents interface for which there is one field, Page.
  • Page is of type React.ComponentType<any>. It offers flexibility in defining the appearance and behavior of your page.

HelpPage in the example above can be defined in page.tsx:

import { Renderer } from \"@k8slens/extensions\";\nimport React from \"react\";\n\nexport class HelpPage extends React.Component<{\nextension: LensRendererExtension;\n}> {\nrender() {\nreturn (\n<div>\n<p>Help yourself</p>\n</div>\n);\n}\n}\n

Note that the HelpPage class defines the extension property. This allows the HelpExtension object to be passed in the global page definition in the React-style. This way, HelpPage can access all HelpExtension subclass data.

This example code shows how to create a global page, but not how to make that page available to the Lens user. Global pages are typically made available in the following ways:

  • To add global pages to the top menu bar, see appMenus in the Main Extension guide.
  • To add global pages as an interactive element in the blue status bar along the bottom of the Lens UI, see statusBarItems.
  • To add global pages to the Welcome Page, see welcomeMenus.
"},{"location":"extensions/guides/renderer-extension/#welcomemenus","title":"welcomeMenus","text":""},{"location":"extensions/guides/renderer-extension/#apppreferences","title":"appPreferences","text":"

The Lens Preferences page is a built-in global page. You can use Lens extensions to add custom preferences to the Preferences page, providing a single location for users to configure global options.

The following example demonstrates adding a custom preference:

import { Renderer } from \"@k8slens/extensions\";\nimport {\nExamplePreferenceHint,\nExamplePreferenceInput,\n} from \"./src/example-preference\";\nimport { observable } from \"mobx\";\nimport React from \"react\";\n\nexport default class ExampleRendererExtension extends Renderer.LensExtension {\n@observable preference = { enabled: false };\n\nappPreferences = [\n{\ntitle: \"Example Preferences\",\ncomponents: {\nInput: () => <ExamplePreferenceInput preference={this.preference} />,\nHint: () => <ExamplePreferenceHint />,\n},\n},\n];\n}\n

appPreferences is an array of objects that satisfies the AppPreferenceRegistration interface. The properties of the appPreferences array objects are defined as follows:

  • title sets the heading text displayed on the Preferences page.
  • components specifies two React.Component objects that define the interface for the preference.
  • Input specifies an interactive input element for the preference.
  • Hint provides descriptive information for the preference, shown below the Input element.

Note

Note that the input and the hint can be comprised of more sophisticated elements, according to the needs of the extension.

ExamplePreferenceInput expects its React props to be set to an ExamplePreferenceProps instance. This is how ExampleRendererExtension handles the state of the preference input. ExampleRendererExtension has a preference field, which you will add to ExamplePreferenceInput.

In this example ExamplePreferenceInput, ExamplePreferenceHint, and ExamplePreferenceProps are defined in ./src/example-preference.tsx as follows:

import { Renderer } from \"@k8slens/extensions\";\nimport { makeObservable } from \"mobx\";\nimport { observer } from \"mobx-react\";\nimport React from \"react\";\n\nconst {\nComponent: { Checkbox },\n} = Renderer;\n\nexport class ExamplePreferenceProps {\npreference: {\nenabled: boolean;\n};\n}\n\n@observer\nexport class ExamplePreferenceInput extends React.Component<ExamplePreferenceProps> {\npublic constructor() {\nsuper({ preference: { enabled: false } });\nmakeObservable(this);\n}\n\nrender() {\nconst { preference } = this.props;\nreturn (\n<Checkbox\nlabel=\"I understand appPreferences\"\nvalue={preference.enabled}\nonChange={(v) => {\npreference.enabled = v;\n}}\n/>\n);\n}\n}\n\nexport class ExamplePreferenceHint extends React.Component {\nrender() {\nreturn <span>This is an example of an appPreference for extensions.</span>;\n}\n}\n

ExamplePreferenceInput implements a simple checkbox using Lens's Renderer.Component.Checkbox using the following properties:

  • label sets the text that displays next to the checkbox.
  • value is initially set to preference.enabled.
  • onChange is a function that responds when the state of the checkbox changes.

ExamplePreferenceInput is defined with the ExamplePreferenceProps React props. This is an object with the single enabled property. It is used to indicate the state of the preference, and it is bound to the checkbox state in onChange.

ExamplePreferenceHint is a simple text span.

The above example introduces the decorators makeObservable and observer from the mobx and mobx-react packages. mobx simplifies state management. Without it, this example would not visually update the checkbox properly when the user activates it. Lens uses mobx extensively for state management of its own UI elements. We recommend that extensions rely on it, as well. Alternatively, you can use React's state management, though mobx is typically simpler to use.

Note that you can manage an extension's state data using an ExtensionStore object, which conveniently handles persistence and synchronization. To simplify this guide, the example above defines a preference field in the ExampleRendererExtension class definition to hold the extension's state. However, we recommend that you manage your extension's state data using ExtensionStore.

"},{"location":"extensions/guides/renderer-extension/#topbaritems","title":"topBarItems","text":""},{"location":"extensions/guides/renderer-extension/#statusbaritems","title":"statusBarItems","text":"

The status bar is the blue strip along the bottom of the Lens UI. statusBarItems are React.ReactNode types. They can be used to display status information, or act as links to global pages as well as external pages.

The following example adds a statusBarItems definition and a globalPages definition to a LensRendererExtension subclass. It configures the status bar item to navigate to the global page upon activation (normally a mouse click):

import { Renderer } from \"@k8slens/extensions\";\nimport { HelpIcon, HelpPage } from \"./page\";\nimport React from \"react\";\n\nexport default class HelpExtension extends Renderer.LensExtension {\nglobalPages = [\n{\nid: \"help\",\ncomponents: {\nPage: () => <HelpPage extension={this} />,\n},\n},\n];\n\nstatusBarItems = [\n{\ncomponents: {\nItem: () => (\n<div\nclassName=\"flex align-center gaps\"\nonClick={() => this.navigate(\"help\")}\n>\n<HelpIcon />\nMy Status Bar Item\n</div>\n),\n},\n},\n];\n}\n

The properties of the statusBarItems array objects are defined as follows:

  • Item specifies the React.Component that will be shown on the status bar. By default, items are added starting from the right side of the status bar. Due to limited space in the status bar, Item will typically specify only an icon or a short string of text. The example above reuses the HelpIcon from the globalPageMenus guide.
  • onClick determines what the statusBarItem does when it is clicked. In the example, onClick is set to a function that calls the LensRendererExtension navigate() method. navigate takes the id of the associated global page as a parameter. Thus, clicking the status bar item activates the associated global pages.
"},{"location":"extensions/guides/renderer-extension/#kubeobjectmenuitems","title":"kubeObjectMenuItems","text":"

An extension can add custom menu items (kubeObjectMenuItems) for specific Kubernetes resource kinds and apiVersions. kubeObjectMenuItems appear under the vertical ellipsis for each listed resource in the cluster dashboard:

They also appear on the title bar of the details page for specific resources:

The following example shows how to add a kubeObjectMenuItems for namespace resources with an associated action:

import React from \"react\";\nimport { Renderer } from \"@k8slens/extensions\";\nimport { NamespaceMenuItem } from \"./src/namespace-menu-item\";\n\ntype KubeObjectMenuProps = Renderer.Component.KubeObjectMenuProps;\ntype Namespace = Renderer.K8sApi.Namespace;\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nkubeObjectMenuItems = [\n{\nkind: \"Namespace\",\napiVersions: [\"v1\"],\ncomponents: {\nMenuItem: (props: KubeObjectMenuProps<Namespace>) => (\n<NamespaceMenuItem {...props} />\n),\n},\n},\n];\n}\n

kubeObjectMenuItems is an array of objects matching the KubeObjectMenuRegistration interface. The example above adds a menu item for namespaces in the cluster dashboard. The properties of the kubeObjectMenuItems array objects are defined as follows:

  • kind specifies the Kubernetes resource type the menu item will apply to.
  • apiVersion specifies the Kubernetes API version number to use with the resource type.
  • components defines the menu item's appearance and behavior.
  • MenuItem provides a function that returns a React.Component given a set of menu item properties. In this example a NamespaceMenuItem object is returned.

NamespaceMenuItem is defined in ./src/namespace-menu-item.tsx:

import React from \"react\";\nimport { Renderer } from \"@k8slens/extensions\";\n\nconst {\nComponent: { terminalStore, MenuItem, Icon },\nNavigation,\n} = Renderer;\n\ntype KubeObjectMenuProps = Renderer.Component.KubeObjectMenuProps;\ntype Namespace = Renderer.K8sApi.Namespace;\n\nexport function NamespaceMenuItem(props: KubeObjectMenuProps<Namespace>) {\nconst { object: namespace, toolbar } = props;\nif (!namespace) return null;\n\nconst namespaceName = namespace.getName();\n\nconst sendToTerminal = (command: string) => {\nterminalStore.sendCommand(command, {\nenter: true,\nnewTab: true,\n});\nNavigation.hideDetails();\n};\n\nconst getPods = () => {\nsendToTerminal(`kubectl get pods -n ${namespaceName}`);\n};\n\nreturn (\n<MenuItem onClick={getPods}>\n<Icon\nmaterial=\"speaker_group\"\ninteractive={toolbar}\ntitle=\"Get pods in terminal\"\n/>\n<span className=\"title\">Get Pods</span>\n</MenuItem>\n);\n}\n

NamespaceMenuItem returns a Renderer.Component.MenuItem which defines the menu item's appearance and its behavior when activated via the onClick property. In the example, getPods() opens a terminal tab and runs kubectl to get a list of pods running in the current namespace.

The name of the namespace is retrieved from props passed into NamespaceMenuItem(). namespace is the props.object, which is of type Renderer.K8sApi.Namespace. Renderer.K8sApi.Namespace is the API for accessing namespaces. The current namespace in this example is simply given by namespace.getName(). Thus, kubeObjectMenuItems afford convenient access to the specific resource selected by the user.

"},{"location":"extensions/guides/renderer-extension/#kubeobjectdetailitems","title":"kubeObjectDetailItems","text":"

An extension can add custom details (kubeObjectDetailItems) for specified Kubernetes resource kinds and apiVersions. These custom details appear on the details page for a specific resource, such as a Namespace as shown here:

The following example shows how to use kubeObjectDetailItems to add a tabulated list of pods to the Namespace resource details page:

import React from \"react\";\nimport { Renderer } from \"@k8slens/extensions\";\nimport { NamespaceDetailsItem } from \"./src/namespace-details-item\";\n\ntype KubeObjectMenuProps = Renderer.Component.KubeObjectMenuProps;\ntype KubeObjectDetailsProps = Renderer.Component.KubeObjectDetailsProps;\ntype Namespace = Renderer.K8sApi.Namespace;\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nkubeObjectDetailItems = [\n{\nkind: \"Namespace\",\napiVersions: [\"v1\"],\npriority: 10,\ncomponents: {\nDetails: (props: KubeObjectDetailsProps<Namespace>) => (\n<NamespaceDetailsItem {...props} />\n),\n},\n},\n];\n}\n

kubeObjectDetailItems is an array of objects matching the KubeObjectDetailRegistration interface. This example above adds a detail item for namespaces in the cluster dashboard. The properties of the kubeObjectDetailItems array objects are defined as follows:

  • kind specifies the Kubernetes resource type the detail item will apply to.
  • apiVersion specifies the Kubernetes API version number to use with the resource type.
  • components defines the detail item's appearance and behavior.
  • Details provides a function that returns a React.Component given a set of detail item properties. In this example a NamespaceDetailsItem object is returned.

NamespaceDetailsItem is defined in ./src/namespace-details-item.tsx:

import { Renderer } from \"@k8slens/extensions\";\nimport { PodsDetailsList } from \"./pods-details-list\";\nimport React from \"react\";\nimport { observable } from \"mobx\";\nimport { observer } from \"mobx-react\";\n\nconst {\nK8sApi: { podsApi },\nComponent: { DrawerTitle },\n} = Renderer;\n\ntype KubeObjectMenuProps = Renderer.Component.KubeObjectMenuProps;\ntype Namespace = Renderer.K8sApi.Namespace;\ntype Pod = Renderer.K8sApi.Pod;\n\n@observer\nexport class NamespaceDetailsItem extends React.Component<\nKubeObjectDetailsProps<Namespace>\n> {\n@observable private pods: Pod[];\n\nasync componentDidMount() {\nconst namespace = this.props.object.getName();\n\nthis.pods = await podsApi.list({ namespace });\n}\n\nrender() {\nreturn (\n<div>\n<DrawerTitle>Pods</DrawerTitle>\n<PodsDetailsList pods={this.pods} />\n</div>\n);\n}\n}\n

Since NamespaceDetailsItem extends React.Component<KubeObjectDetailsProps<Namespace>>, it can access the current namespace object (type Namespace) through this.props.object. You can query this object for many details about the current namespace. In the example above, componentDidMount() gets the namespace's name using the Namespace getName() method. Use the namespace's name to limit the list of pods only to those in the relevant namespace. To get this list of pods, this example uses the Kubernetes pods API podsApi.list() method. The podsApi is automatically configured for the active cluster.

Note that podsApi.list() is an asynchronous method. Getting the pods list should occur prior to rendering the NamespaceDetailsItem. It is a common technique in React development to await async calls in componentDidMount(). However, componentDidMount() is called right after the first call to render(). In order to effect a subsequent render() call, React must be made aware of a state change. Like in the appPreferences guide, mobx and mobx-react are used to ensure NamespaceDetailsItem renders when the pods list updates. This is done simply by marking the pods field as an observable and the NamespaceDetailsItem class itself as an observer.

Finally, the NamespaceDetailsItem renders using the render() method. Details are placed in drawers, and using Renderer.Component.DrawerTitle provides a separator from details above this one. Multiple details in a drawer can be placed in <Renderer.Component.DrawerItem> elements for further separation, if desired. The rest of this example's details are defined in PodsDetailsList, found in ./pods-details-list.tsx:

import React from \"react\";\nimport { Renderer } from \"@k8slens/extensions\";\n\nconst {\nComponent: { TableHead, TableRow, TableCell, Table },\n} = Renderer;\n\ntype Pod = Renderer.K8sApi.Pod;\n\ninterface PodsDetailsListProps {\npods?: Pod[];\n}\n\nexport class PodsDetailsList extends React.Component<PodsDetailsListProps> {\ngetTableRow = (pod: Pod) => {\nreturn (\n<TableRow key={index} nowrap>\n<TableCell className=\"podName\">{pods[index].getName()}</TableCell>\n<TableCell className=\"podAge\">{pods[index].getAge()}</TableCell>\n<TableCell className=\"podStatus\">{pods[index].getStatus()}</TableCell>\n</TableRow>\n);\n};\n\nrender() {\nconst { pods } = this.props;\n\nif (!pods?.length) {\nreturn null;\n}\n\nreturn (\n<div>\n<Table>\n<TableHead>\n<TableCell className=\"podName\">Name</TableCell>\n<TableCell className=\"podAge\">Age</TableCell>\n<TableCell className=\"podStatus\">Status</TableCell>\n</TableHead>\n{pods.map(this.getTableRow)}\n</Table>\n</div>\n);\n}\n}\n

PodsDetailsList produces a simple table showing a list of the pods found in this namespace:

Obtain the name, age, and status for each pod using the Renderer.K8sApi.Pod methods. Construct the table using the Renderer.Component.Table and related elements.

For each pod the name, age, and status are obtained using the Renderer.K8sApi.Pod methods. The table is constructed using the Renderer.Component.Table and related elements. See Component documentation for further details.

"},{"location":"extensions/guides/renderer-extension/#kubeobjectstatustexts","title":"kubeObjectStatusTexts","text":""},{"location":"extensions/guides/renderer-extension/#kubeworkloadsoverviewitems","title":"kubeWorkloadsOverviewItems","text":""},{"location":"extensions/guides/renderer-extension/#entitysettings","title":"entitySettings","text":""},{"location":"extensions/guides/renderer-extension/#catalogentitydetailitems","title":"catalogEntityDetailItems","text":""},{"location":"extensions/guides/renderer-extension/#commandpalettecommands","title":"commandPaletteCommands","text":""},{"location":"extensions/guides/renderer-extension/#protocolhandlers","title":"protocolHandlers","text":"

See the Protocol Handlers Guide

"},{"location":"extensions/guides/resource-stack/","title":"Resource Stack (Cluster Feature)","text":"

A cluster feature is a set of Kubernetes resources that can be applied to and managed within the active cluster. The Renderer.K8sApi.ResourceStack class provides the functionality to input and apply kubernetes resources to a cluster. It is up to the extension developer to manage the life cycle of the resource stack. It could be applied automatically to a cluster by the extension, or the end-user could be required to install it.

The code examples in this section show how to create a resource stack, and define a cluster feature that is configurable from the cluster Settings page.

Info

To access the cluster Settings page, right-click the relevant cluster in the left side menu and click Settings.

The resource stack in this example consists of a single kubernetes resource:

apiVersion: v1\nkind: Pod\nmetadata:\nname: example-pod\nspec:\ncontainers:\n- name: example-pod\nimage: nginx\n

It is simply a pod named example-pod, running nginx. Assume this content is in the file ../resources/example-pod.yml.

The following code sample shows how to use the Renderer.K8sApi.ResourceStack to manage installing and uninstalling this resource stack:

import { Renderer, Common } from \"@k8slens/extensions\";\nimport * as path from \"path\";\n\nconst {\nK8sApi: {\nResourceStack,\nforCluster,\nPod,\n}\n} = Renderer;\n\ntype ResourceStack = Renderer.K8sApi.ResourceStack;\ntype Pod = Renderer.K8sApi.Pod;\ntype KubernetesCluster = Common.Catalog.KubernetesCluster;\n\nexport class ExampleClusterFeature {\nprotected stack: ResourceStack;\n\nconstructor(protected cluster: KubernetesCluster) {\nthis.stack = new ResourceStack(cluster, \"example-resource-stack\");\n}\n\nget resourceFolder() {\nreturn path.join(__dirname, \"../resources/\");\n}\n\ninstall(): Promise<string> {\nconsole.log(\"installing example-pod\");\nreturn this.stack.kubectlApplyFolder(this.resourceFolder);\n}\n\nasync isInstalled(): Promise<boolean> {\ntry {\nconst podApi = forCluster(this.cluster, Pod);\nconst examplePod = await podApi.get({name: \"example-pod\", namespace: \"default\"});\n\nif (examplePod?.kind) {\nconsole.log(\"found example-pod\");\nreturn true;\n}\n} catch(e) {\nconsole.log(\"Error getting example-pod:\", e);\n}\nconsole.log(\"didn't find example-pod\");\n\nreturn false;\n}\n\nasync uninstall(): Promise<string> {\nconsole.log(\"uninstalling example-pod\");\nreturn this.stack.kubectlDeleteFolder(this.resourceFolder);\n}\n}\n

The ExampleClusterFeature class constructor takes a Common.Catalog.KubernetesCluster argument. This is the cluster that the resource stack will be applied to, and the constructor instantiates a Renderer.K8sApi.ResourceStack as such. ExampleClusterFeature implements an install() method which simply invokes the kubectlApplyFolder() method of the Renderer.K8sApi.ResourceStack class. kubectlApplyFolder() applies to the cluster all kubernetes resources found in the folder passed to it, in this case ../resources. Similarly, ExampleClusterFeature implements an uninstall() method which simply invokes the kubectlDeleteFolder() method of the Renderer.K8sApi.ResourceStack class. kubectlDeleteFolder() tries to delete from the cluster all kubernetes resources found in the folder passed to it, again in this case ../resources.

ExampleClusterFeature also implements an isInstalled() method, which demonstrates how you can utilize the kubernetes api to inspect the resource stack status. isInstalled() simply tries to find a pod named example-pod, as a way to determine if the pod is already installed. This method can be useful in creating a context-sensitive UI for installing/uninstalling the feature, as demonstrated in the next sample code.

To allow the end-user to control the life cycle of this cluster feature the following code sample shows how to implement a user interface based on React and custom Lens UI components:

 import React from \"react\";\nimport { Common, Renderer } from \"@k8slens/extensions\";\nimport { observer } from \"mobx-react\";\nimport { computed, observable, makeObservable } from \"mobx\";\nimport { ExampleClusterFeature } from \"./example-cluster-feature\";\n\nconst {\nComponent: {\nSubTitle, Button,\n}\n} = Renderer;\n\ninterface ExampleClusterFeatureSettingsProps {\ncluster: Common.Catalog.KubernetesCluster;\n}\n\n@observer\nexport class ExampleClusterFeatureSettings extends React.Component<ExampleClusterFeatureSettingsProps> {\nconstructor(props: ExampleClusterFeatureSettingsProps) {\nsuper(props);\nmakeObservable(this);\n}\n\n@observable installed = false;\n@observable inProgress = false;\n\nfeature: ExampleClusterFeature;\n\nasync componentDidMount() {\nthis.feature = new ExampleClusterFeature(this.props.cluster);\n\nawait this.updateFeatureState();\n}\n\nasync updateFeatureState() {\nthis.installed = await this.feature.isInstalled();\n}\n\nasync save() {\nthis.inProgress = true;\n\ntry {\nif (this.installed) {\nawait this.feature.uninstall();\n} else {\nawait this.feature.install();\n}\n} finally {\nthis.inProgress = false;\n\nawait this.updateFeatureState();\n}\n}\n\n@computed get buttonLabel()\u00a0{\nif (this.inProgress && this.installed) return \"Uninstalling ...\";\nif (this.inProgress) return \"Applying ...\";\n\nif (this.installed) {\nreturn \"Uninstall\";\n}\n\nreturn \"Apply\";\n}\n\nrender() {\nreturn (\n<>\n<section>\n<SubTitle title=\"Example Cluster Feature using a Resource Stack\" />\n<Button\nlabel={this.buttonLabel}\nwaiting={this.inProgress}\nonClick={() => this.save()}\nprimary />\n</section>\n</>\n);\n}\n}\n

The ExampleClusterFeatureSettings class extends React.Component and simply renders a subtitle and a button. ExampleClusterFeatureSettings takes the cluster as a prop and when the React component has mounted the ExampleClusterFeature is instantiated using this cluster (in componentDidMount()). The rest of the logic concerns the button appearance and action, based on the ExampleClusterFeatureSettings fields installed and inProgress. The installed value is of course determined using the aforementioned ExampleClusterFeature method isInstalled(). The inProgress value is true while waiting for the feature to be installed (or uninstalled).

Note that the button is a Renderer.Component.Button element and this example takes advantage of its waiting prop to show a \"waiting\" animation while the install (or uninstall) is in progress. Using elements from Renderer.Component is encouraged, to take advantage of their built-in properties, and to ensure a common look and feel.

Also note that MobX 6 is used for state management, ensuring that the UI is rerendered when state has changed. The ExampleClusterFeatureSettings class is marked as an @observer, and its constructor must call makeObservable(). As well, the installed and inProgress fields are marked as @observable, ensuring that the button gets rerendered any time these fields change.

Finally, ExampleClusterFeatureSettings needs to be connected to the extension, and would typically appear on the cluster Settings page via a Renderer.LensExtension.entitySettings entry. The ExampleExtension would look like this:

import { Common, Renderer } from \"@k8slens/extensions\";\nimport { ExampleClusterFeatureSettings } from \"./src/example-cluster-feature-settings\"\nimport React from \"react\"\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nentitySettings = [\n{\napiVersions: [\"entity.k8slens.dev/v1alpha1\"],\nkind: \"KubernetesCluster\",\ntitle: \"Example Cluster Feature\",\npriority: 5,\ncomponents: {\nView: ({ entity = null }: { entity: Common.Catalog.KubernetesCluster}) => (\n<ExampleClusterFeatureSettings cluster={entity} />\n)\n}\n}\n];\n\n}\n

An entity setting is added to the entitySettings array field of the Renderer.LensExtension class. Because Lens's catalog can contain different kinds of entities, the kind must be identified. For more details about the catalog see the Catalog Guide. Clusters are a built-in kind, so the apiVersions and kind fields should be set as above. The title is shown as a navigation item on the cluster Settings page and the components.View is displayed when the navigation item is clicked on. The components.View definition above shows how the ExampleClusterFeatureSettings element is included, and how its cluster prop is set. priority determines the order of the entity settings, the higher the number the higher in the navigation panel the setting is placed. The default value is 50.

The final result looks like this:

ExampleClusterFeature and ExampleClusterFeatureSettings demonstrate a cluster feature for a simple resource stack. In practice a resource stack can include many resources, and require more sophisticated life cycle management (upgrades, partial installations, etc.) Using Renderer.K8sApi.ResourceStack and entitySettings it is possible to implement solutions for more complex cluster features. The Lens Metrics setting (on the cluster Settings page) is a good example of an advanced solution.

"},{"location":"extensions/guides/stores/","title":"Stores","text":"

Stores are components that persist and synchronize state data. Lens uses a number of stores to maintain various kinds of state information, including:

  • The ClusterStore manages cluster state data (such as cluster details), and it tracks which cluster is active.
  • The WorkspaceStore manages workspace state data (such as the workspace name), and and it tracks which clusters belong to a given workspace.
  • The ExtensionStore manages custom extension state data.

This guide focuses on the ExtensionStore.

"},{"location":"extensions/guides/stores/#extensionstore","title":"ExtensionStore","text":"

Extension developers can create their own store for managing state data by extending the ExtensionStore class. This guide shows how to create a store for the appPreferences guide example, which demonstrates how to add a custom preference to the Preferences page. The preference is a simple boolean that indicates whether or not something is enabled. However, in the example, the enabled state is not stored anywhere, and it reverts to the default when Lens is restarted.

Store.ExtensionStore's child class will need to be created before being used. It is recommended to call the inherited static method getInstanceOrCreate() only in one place, generally within you extension's onActivate() method. It is also recommenced to delete the instance, using the inherited static method resetInstance(), in your extension's onDeactivate() method. Everywhere else in your code you should use the getInstance() static method. This is so that your data is kept up to date and not persisted longer than expected.

The following example code creates a store for the appPreferences guide example:

import { Common } from \"@k8slens/extensions\";\nimport { observable, makeObservable } from \"mobx\";\n\nexport type ExamplePreferencesModel = {\nenabled: boolean;\n};\n\nexport class ExamplePreferencesStore extends Common.Store.ExtensionStore<ExamplePreferencesModel> {\n\n@observable  enabled = false;\n\nprivate constructor() {\nsuper({\nconfigName: \"example-preferences-store\",\ndefaults: {\nenabled: false\n}\n});\nmakeObservable(this);\n}\n\nprotected fromStore({ enabled }: ExamplePreferencesModel): void {\nthis.enabled = enabled;\n}\n\ntoJSON(): ExamplePreferencesModel {\nreturn {\nenabled: this.enabled\n};\n}\n}\n

First, our example defines the extension's data model using the simple ExamplePreferencesModel type. This has a single field, enabled, which represents the preference's state. ExamplePreferencesStore extends Store.ExtensionStore, which is based on the ExamplePreferencesModel. The enabled field is added to the ExamplePreferencesStore class to hold the \"live\" or current state of the preference. Note the use of the observable decorator on the enabled field. The appPreferences guide example uses MobX for the UI state management, ensuring the checkbox updates when it's activated by the user.

Next, our example implements the constructor and two abstract methods. The constructor specifies the name of the store (\"example-preferences-store\") and the default (initial) value for the preference state (enabled: false). Lens internals call the fromStore() method when the store loads. It gives the extension the opportunity to retrieve the stored state data values based on the defined data model. The enabled field of the ExamplePreferencesStore is set to the value from the store whenever fromStore() is invoked. The toJSON() method is complementary to fromStore(). It is called when the store is being saved. toJSON() must provide a JSON serializable object, facilitating its storage in JSON format.

Finally, ExamplePreferencesStore is created by calling ExamplePreferencesStore.getInstanceOrCreate(), and exported for use by other parts of the extension. Note that ExamplePreferencesStore is a singleton. Calling this function will create an instance if one has not been made before. Through normal use you should call ExamplePreferencesStore.getInstance() as that will throw an error if an instance does not exist. This provides some logical safety in that it limits where a new instance can be created. Thus it prevents an instance from being created when the constructor args are not present at the call site.

If you are doing some cleanup it is recommended to call ExamplePreferencesStore.getInstance(false) which returns undefined instead of throwing when there is no instance.

The following example code, modified from the appPreferences guide demonstrates how to use the extension store. ExamplePreferencesStore must be loaded in the main process, where loaded stores are automatically saved when exiting Lens. This can be done in ./main.ts:

import { Main } from \"@k8slens/extensions\";\nimport { ExamplePreferencesStore } from \"./src/example-preference-store\";\n\nexport default class ExampleMainExtension extends Main.LensExtension {\nasync onActivate() {\nawait ExamplePreferencesStore.getInstanceOrCreate().loadExtension(this);\n}\n}\n

Here, ExamplePreferencesStore loads with ExamplePreferencesStore.getInstanceOrCreate().loadExtension(this), which is conveniently called from the onActivate() method of ExampleMainExtension. Similarly, ExamplePreferencesStore must load in the renderer process where the appPreferences are handled. This can be done in ./renderer.ts:

import { Renderer } from \"@k8slens/extensions\";\nimport { ExamplePreferenceHint, ExamplePreferenceInput } from \"./src/example-preference\";\nimport { ExamplePreferencesStore } from \"./src/example-preference-store\";\nimport React from \"react\";\n\nexport default class ExampleRendererExtension extends Renderer.LensExtension {\n\nasync onActivate() {\nawait ExamplePreferencesStore.getInstanceOrCreate().loadExtension(this);\n}\n\nappPreferences = [\n{\ntitle: \"Example Preferences\",\ncomponents: {\nInput: () => <ExamplePreferenceInput />,\nHint: () => <ExamplePreferenceHint/>\n}\n}\n];\n}\n

Again, ExamplePreferencesStore.getInstanceOrCreate().loadExtension(this) is called to load ExamplePreferencesStore, this time from the onActivate() method of ExampleRendererExtension.

ExamplePreferenceInput is defined in ./src/example-preference.tsx:

import { Renderer } from \"@k8slens/extensions\";\nimport { observer } from \"mobx-react\";\nimport React from \"react\";\nimport { ExamplePreferencesStore } from \"./example-preference-store\";\n\nconst {\nComponent: {\nCheckbox,\n},\n} = Renderer;\n\n@observer\nexport class ExamplePreferenceInput extends React.Component {\n\nrender() {\nreturn (\n<Checkbox\nlabel=\"I understand appPreferences\"\nvalue={ExamplePreferencesStore.getInstance().enabled}\nonChange={v => { ExamplePreferencesStore.getInstance().enabled = v; }}\n/>\n);\n}\n}\n\nexport class ExamplePreferenceHint extends React.Component {\nrender() {\nreturn (\n<span>This is an example of an appPreference for extensions.</span>\n);\n}\n}\n

The only change here is that ExamplePreferenceProps defines its preference field as an ExamplePreferencesStore type. Everything else works as before, except that now the enabled state persists across Lens restarts because it is managed by the ExamplePreferencesStore.

"},{"location":"extensions/guides/working-with-mobx/","title":"Working with MobX","text":""},{"location":"extensions/guides/working-with-mobx/#introduction","title":"Introduction","text":"

Lens uses MobX on top of React's state management system. The result is a more declarative state management style, rather than React's native setState mechanism.

You can review how React handles state management here.

The following is a quick overview:

  • React.Component is generic with respect to both props and state (which default to the empty object type).
  • props should be considered read-only from the point of view of the component, and it is the mechanism for passing in arguments to a component.
  • state is a component's internal state, and can be read by accessing the super-class field state.
  • state must be updated using the setState parent method which merges the new data with the old state.
  • React does some optimizations around re-rendering components after quick successions of setState calls.
"},{"location":"extensions/guides/working-with-mobx/#how-mobx-works","title":"How MobX Works:","text":"

MobX is a package that provides an abstraction over React's state management system. The three main concepts are:

  • observable is a marker for data stored in the component's state.
  • action is a function that modifies any observable data.
  • computed is a marker for data that is derived from observable data, but that is not actually stored. Think of this as computing isEmpty rather than an observable field called count.

Further reading is available on the MobX website.

"},{"location":"extensions/testing-and-publishing/publishing/","title":"Publishing Extensions","text":"

To be able to easily share extensions with users they need to be published somewhere. Lens currently only supports installing extensions from NPM tarballs. All hosted extensions must, therefore, be retrievable in a NPM tarball.

"},{"location":"extensions/testing-and-publishing/publishing/#places-to-host-your-extension","title":"Places To Host Your Extension","text":"

We recommend to host your extension somewhere on the web so that it is easy for people to search for and download it. We recommend either hosting it as an NPM package on https://www.npmjs.com or through GitHub releases. We recommend against using GitHub packages (https://github.com/features/packages) as it requires a GitHub token to access the package.

"},{"location":"extensions/testing-and-publishing/publishing/#publishing-via-npm","title":"Publishing via NPM","text":"

This is the easiest method of publishing as NPM comes built in with mechanism to get a link to download the package as a tarball. Once you have set up an account with NPM (https://www.npmjs.com/signup) and logged in with their CLI (npm login) you will be ready to publish.

  • Run npm version <major|minor|patch> to bump the version of your extension by the appropriate amount.
  • Run npm publish to publish your extension to NPM
  • Run git push && git push --tags to push the commit that NPM creates to your git remote.

It is probably a good idea to put into your README.md the following instructions for your users to get the tarball download link.

npm view <extension-name> dist.tarball\n

This will output the link that they will need to give to Lens to install your extension.

"},{"location":"extensions/testing-and-publishing/publishing/#publish-via-github-releases","title":"Publish via GitHub Releases","text":"

Another method of publishing your extensions is to do so with the releases mechanism built into GitHub. We recommend reading GitHub's Releases Documentation for how to actually do the steps of a release. The following will be a quick walk through on how to make the tarball which will be the released file.

"},{"location":"extensions/testing-and-publishing/publishing/#making-a-npm-tarball-of-your-extension","title":"Making a NPM Tarball of Your Extension","text":"

While this is necessary for hosting on GitHub releases, this is also the means for creating a tarball if you plan on hosting on a different file hosting platform.

Say you have your project folder at ~/my-extension/ and you want to create an NPM package we need to do the following within your git repo:

npm pack\n

This will create a NPM tarball that can be hosted on GitHub Releases or any other publicly available file hosting service.

"},{"location":"extensions/testing-and-publishing/testing/","title":"Testing Extensions","text":""},{"location":"extensions/testing-and-publishing/testing/#renderer-process-unit-testing","title":"Renderer Process Unit Testing","text":"

UI components in the extension's renderer process are based on React/ReactDOM. These components can be tested by popular React testing tools like React Testing Library.

If you are using the Yeoman Lens Extension Generator to scaffold extension project then the testing environment for render process is already set up for you. Just use npm start or yarn test to run the tests.

For example, I have a component GlobalPageMenuIcon and want to test if props.navigate is called when user clicks the icon.

My component GlobalPageMenuIcon

import React from \"react\"\nimport { Renderer } from \"@k8slens/extensions\";\n\nconst {\nComponent: {\nIcon,\n},\n} = Renderer;\n\nconst GlobalPageMenuIcon = ({ navigate }: { navigate?: () => void }): JSX.Element => (\n<Icon\nmaterial=\"trip_origin\"\nonClick={() => navigate()}\ndata-testid=\"global-page-menu-icon\"\n/>\n)\n

The test

import React from \"react\"\nimport { render, screen, fireEvent } from \"@testing-library/react\";\n\nimport GlobalPageMenuIcon from \"./GlobalPageMenuIcon\";\n\ntest(\"click called navigate()\", () => {\nconst navigate = jest.fn();\nrender(<GlobalPageMenuIcon navigate={navigate} />);\nfireEvent.click(screen.getByTestId(\"global-page-menu-icon\"));\nexpect(navigate).toHaveBeenCalled();\n});\n

In the example we used React Testing Library but any React testing framework can be used to test renderer process UI components.

There are more example tests in the generator's template. Extend your tests based on the examples.

"},{"location":"extensions/testing-and-publishing/testing/#main-process-unit-testing","title":"Main Process Unit Testing","text":"

Code in the extension's main process consists of normal JavaScript files that have access to extension api, you can write unit tests using any testing framework.

If you are using the Yeoman Lens Extension Generator to scaffold your extension project then the Jest testing environment is set up for you. Just use npm start or yarn test to run the tests.

"},{"location":"extensions/testing-and-publishing/testing/#tips","title":"Tips","text":""},{"location":"extensions/testing-and-publishing/testing/#consolelog","title":"Console.log","text":"

Extension developers might find console.log() useful for printing out information and errors from extensions. To use console.log(), note that Lens is based on Electron, and that Electron has two types of processes: Main and Renderer.

"},{"location":"extensions/testing-and-publishing/testing/#renderer-process-logs","title":"Renderer Process Logs","text":"

In the Renderer process, console.log() is printed in the Console in Developer Tools (View > Toggle Developer Tools).

"},{"location":"extensions/testing-and-publishing/testing/#main-process-logs","title":"Main Process Logs","text":"

Viewing the logs from the Main process is a little trickier, since they cannot be printed using Developer Tools.

"},{"location":"extensions/testing-and-publishing/testing/#macos","title":"macOS","text":"

On macOS, view the Main process logs by running Lens from the terminal:

/Applications/Lens.app/Contents/MacOS/Lens\n

You can also use Console.app to view the Main process logs.

"},{"location":"extensions/testing-and-publishing/testing/#linux","title":"Linux","text":"

On Linux, you can access the Main process logs using the Lens PID. First get the PID:

ps aux | grep Lens | grep -v grep\n

Then get the Main process logs using the PID:

tail -f /proc/[pid]/fd/1 # stdout (console.log)\ntail -f /proc/[pid]/fd/2 # stdout (console.error)\n
"},{"location":"extensions/usage/","title":"Using Extensions","text":"

The features that Lens includes out-of-the-box are just the start. Lens extensions let you add new features to your installation to support your workflow. Rich extensibility model lets extension authors plug directly into the Lens UI and contribute functionality through the same APIs used by Lens itself. The start using Lens Extensions go to File (or Lens on macOS) > Extensions in the application menu. This is the Extensions management page where all the management of the extensions you want to use is done.

"},{"location":"extensions/usage/#installing-an-extension","title":"Installing an Extension","text":"

There are three ways to install extensions. If you have the extension as a .tgz file then dragging and dropping it in the extension management page will install it for you. If it is hosted on the web, you can paste the URL and click Install and Lens will download and install it. The third way is to move the extension into your ~/.k8slens/extensions (or C:\\Users\\<user>\\.k8slens\\extensions) folder and Lens will automatically detect it and install the extension.

"},{"location":"extensions/usage/#enabling-or-disabling-an-extension","title":"Enabling or Disabling an Extension","text":"

Go to the extension management page and click either the Enable or Disable buttons. Extensions will be enabled by default when you first install them. A disabled extension is not loaded by Lens and is not run.

"},{"location":"extensions/usage/#uninstalling-an-extension","title":"Uninstalling an Extension","text":"

If, for whatever reason, you wish to remove the installation of an extension simple click the Uninstall button. This will remove all the files that Lens would need to run the extension.

"}]} \ No newline at end of file diff --git a/master/sitemap.xml.gz b/master/sitemap.xml.gz index 73c579b95b859472bd8f0f374a0a7391151a8325..1731094fe189b343bef108da33614576a255fedb 100644 GIT binary patch delta 16 XcmbOyJWrTizMF%?tSN3I`*cnKCbI;R delta 16 XcmbOyJWrTizMF&N<;&QO?9({`E&T