https://headlamp.dev/assets/js/4cf92fa1.3fdbfc97.js

1"use strict";(self.webpackChunkheadlamp_website=self.webpackChunkheadlamp_website||[]).push([[5741],{28453:(e,s,t)=>{t.d(s,{R:()=>c,x:()=>a});var n=t(96540);const i={},r=n.createContext(i);function c(e){const s=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),n.createElement(r.Provider,{value:s},e.children)}},48806:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>a,toc:()=>l});var n=t(74848),i=t(28453);const r={},c="Interface: KubeResourceQuota",a={id:"latest/development/api/lib/k8s/resourceQuota/interfaces/KubeResourceQuota",title:"Interface: KubeResourceQuota",description:"Defined in44",source:"@site/docs/latest/development/api/lib/k8s/resourceQuota/interfaces/KubeResourceQuota.md",sourceDirName:"latest/development/api/lib/k8s/resourceQuota/interfaces",slug:"/latest/development/api/lib/k8s/resourceQuota/interfaces/KubeResourceQuota",permalink:"/docs/latest/development/api/lib/k8s/resourceQuota/interfaces/KubeResourceQuota",draft:!1,unlisted:!1,editUrl:"https://github.com/kubernetes-sigs/headlamp/edit/main/docs/development/api/lib/k8s/resourceQuota/interfaces/KubeResourceQuota.md",tags:[],version:"current",frontMatter:{},sidebar:"mainSidebar",previous:{title:"Class: ResourceQuota",permalink:"/docs/latest/development/api/lib/k8s/resourceQuota/classes/ResourceQuota"},next:{title:"lib/k8s/role",permalink:"/docs/latest/development/api/lib/k8s/role/API"}},d={},l=[{value:"Extends",id:"extends",level:2},{value:"Indexable",id:"indexable",level:2},{value:"Properties",id:"properties",level:2},{value:"actionType?",id:"actiontype",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"apiVersion?",id:"apiversion",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"items?",id:"items",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"key?",id:"key",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"kind",id:"kind",level:3},{value:"See",id:"see",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"lastTimestamp?",id:"lasttimestamp",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"metadata",id:"metadata",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"spec",id:"spec",level:3},{value:"Overrides",id:"overrides",level:4},{value:"status?",id:"status",level:3},{value:"Overrides",id:"overrides-1",level:4}];function o(e){const s={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",pre:"pre",ul:"ul",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.h1,{id:"interface-kuberesourcequota",children:"Interface: KubeResourceQuota"}),"\n",(0,n.jsxs)(s.p,{children:["Defined in: ",(0,n.jsx)(s.a,{href:"https://github.com/kubernetes-sigs/headlamp/blob/9cb8e9a311f736f645f4a06f251f59bddca3cf60/frontend/src/lib/k8s/resourceQuota.ts#L44",children:"lib/k8s/resourceQuota.ts:44"})]}),"\n",(0,n.jsx)(s.p,{children:"This is the base interface for all Kubernetes resources, i.e. it contains fields\nthat all Kubernetes resources have."}),"\n",(0,n.jsx)(s.h2,{id:"extends",children:"Extends"}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:(0,n.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface",children:(0,n.jsx)(s.code,{children:"KubeObjectInterface"})})}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"indexable",children:"Indexable"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ts",children:"[otherProps: string]: any\n"})}),"\n",(0,n.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(s.h3,{id:"actiontype",children:"actionType?"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ts",children:"optional actionType?: any;\n"})}),"\n",(0,n.jsxs)(s.p,{children:["Defined in: ",(0,n.jsx)(s.a,{href:"https://github.com/kubernetes-sigs/headlamp/blob/9cb8e9a311f736f645f4a06f251f59bddca3cf60/frontend/src/lib/k8s/KubeObject.ts#L787",children:"lib/k8s/KubeObject.ts:787"})]}),"\n",(0,n.jsx)(s.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface",children:(0,n.jsx)(s.code,{children:"KubeObjectInterface"})}),".",(0,n.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface#actiontype",children:(0,n.jsx)(s.code,{children:"actionType"})})]}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"apiversion",children:"apiVersion?"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ts",children:"optional apiVersion?: string;\n"})}),"\n",(0,n.jsxs)(s.p,{children:["Defined in: ",(0,n.jsx)(s.a,{href:"https://github.com/kubernetes-sigs/headlamp/blob/9cb8e9a311f736f645f4a06f251f59bddca3cf60/frontend/src/lib/k8s/KubeObject.ts#L782",children:"lib/k8s/KubeObject.ts:782"})]}),"\n",(0,n.jsx)(s.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface",children:(0,n.jsx)(s.code,{children:"KubeObjectInterface"})}),".",(0,n.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface#apiversion",children:(0,n.jsx)(s.code,{children:"apiVersion"})})]}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"items",children:"items?"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ts",children:"optional items?: any[];\n"})}),"\n",(0,n.jsxs)(s.p,{children:["Defined in: ",(0,n.jsx)(s.a,{href:"https://github.com/kubernetes-sigs/headlamp/blob/9cb8e9a311f736f645f4a06f251f59bddca3cf60/frontend/src/lib/k8s/KubeObject.ts#L786",children:"lib/k8s/KubeObject.ts:786"})]}),"\n",(0,n.jsx)(s.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface",children:(0,n.jsx)(s.code,{children:"KubeObjectInterface"})}),".",(0,n.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface#items",children:(0,n.jsx)(s.code,{children:"items"})})]}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"key",children:"key?"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ts",children:"optional key?: any;\n"})}),"\n",(0,n.jsxs)(s.p,{children:["Defined in: ",(0,n.jsx)(s.a,{href:"https://github.com/kubernetes-sigs/headlamp/blob/9cb8e9a311f736f645f4a06f251f59bddca3cf60/frontend/src/lib/k8s/KubeObject.ts#L789",children:"lib/k8s/KubeObject.ts:789"})]}),"\n",(0,n.jsx)(s.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface",children:(0,n.jsx)(s.code,{children:"KubeObjectInterface"})}),".",(0,n.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface#key",children:(0,n.jsx)(s.code,{children:"key"})})]}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"kind",children:"kind"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ts",children:"kind: string;\n"})}),"\n",(0,n.jsxs)(s.p,{children:["Defined in: ",(0,n.jsx)(s.a,{href:"https://github.com/kubernetes-sigs/headlamp/blob/9cb8e9a311f736f645f4a06f251f59bddca3cf60/frontend/src/lib/k8s/KubeObject.ts#L781",children:"lib/k8s/KubeObject.ts:781"})]}),"\n",(0,n.jsx)(s.p,{children:"Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to."}),"\n",(0,n.jsx)(s.p,{children:"In CamelCase."}),"\n",(0,n.jsx)(s.p,{children:"Cannot be updated."}),"\n",(0,n.jsx)(s.h4,{id:"see",children:"See"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.a,{href:"https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",children:"more info"})}),"\n",(0,n.jsx)(s.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface",children:(0,n.jsx)(s.code,{children:"KubeObjectInterface"})}),".",(0,n.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface#kind",children:(0,n.jsx)(s.code,{children:"kind"})})]}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"lasttimestamp",children:"lastTimestamp?"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ts",children:"optional lastTimestamp?: string;\n"})}),"\n",(0,n.jsxs)(s.p,{children:["Defined in: ",(0,n.jsx)(s.a,{href:"https://github.com/kubernetes-sigs/headlamp/blob/9cb8e9a311f736f645f4a06f251f59bddca3cf60/frontend/src/lib/k8s/KubeObject.ts#L788",children:"lib/k8s/KubeObject.ts:788"})]}),"\n",(0,n.jsx)(s.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface",children:(0,n.jsx)(s.code,{children:"KubeObjectInterface"})}),".",(0,n.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface#lasttimestamp",children:(0,n.jsx)(s.code,{children:"lastTimestamp"})})]}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"metadata",children:"metadata"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ts",children:"metadata: KubeMetadata;\n"})}),"\n",(0,n.jsxs)(s.p,{children:["Defined in: ",(0,n.jsx)(s.a,{href:"https://github.com/kubernetes-sigs/headlamp/blob/9cb8e9a311f736f645f4a06f251f59bddca3cf60/frontend/src/lib/k8s/KubeObject.ts#L783",children:"lib/k8s/KubeObject.ts:783"})]}),"\n",(0,n.jsx)(s.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface",children:(0,n.jsx)(s.code,{children:"KubeObjectInterface"})}),".",(0,n.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface#metadata",children:(0,n.jsx)(s.code,{children:"metadata"})})]}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"spec",children:"spec"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ts",children:"spec: spec;\n"})}),"\n",(0,n.jsxs)(s.p,{children:["Defined in: ",(0,n.jsx)(s.a,{href:"https://github.com/kubernetes-sigs/headlamp/blob/9cb8e9a311f736f645f4a06f251f59bddca3cf60/frontend/src/lib/k8s/resourceQuota.ts#L45",children:"lib/k8s/resourceQuota.ts:45"})]}),"\n",(0,n.jsx)(s.h4,{id:"overrides",children:"Overrides"}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface",children:(0,n.jsx)(s.code,{children:"KubeObjectInterface"})}),".",(0,n.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface#spec",children:(0,n.jsx)(s.code,{children:"spec"})})]}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"status",children:"status?"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ts",children:"optional status?: status;\n"})}),"\n",(0,n.jsxs)(s.p,{children:["Defined in: ",(0,n.jsx)(s.a,{href:"https://github.com/kubernetes-sigs/headlamp/blob/9cb8e9a311f736f645f4a06f251f59bddca3cf60/frontend/src/lib/k8s/resourceQuota.ts#L46",children:"lib/k8s/resourceQuota.ts:46"})]}),"\n",(0,n.jsx)(s.h4,{id:"overrides-1",children:"Overrides"}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface",children:(0,n.jsx)(s.code,{children:"KubeObjectInterface"})}),".",(0,n.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface#status",children:(0,n.jsx)(s.code,{children:"status"})})]})]})}function h(e={}){const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(o,{...e})}):o(e)}}}]);