1"use strict";(self.webpackChunkheadlamp_website=self.webpackChunkheadlamp_website||[]).push([[6004],{8800:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>d,contentTitle:()=>c,default:()=>o,frontMatter:()=>r,metadata:()=>l,toc:()=>a});var i=n(74848),t=n(28453);const r={},c="Interface: KubeRole",l={id:"latest/development/api/lib/k8s/role/interfaces/KubeRole",title:"Interface: KubeRole",description:"Defined in20",source:"@site/docs/latest/development/api/lib/k8s/role/interfaces/KubeRole.md",sourceDirName:"latest/development/api/lib/k8s/role/interfaces",slug:"/latest/development/api/lib/k8s/role/interfaces/KubeRole",permalink:"/docs/latest/development/api/lib/k8s/role/interfaces/KubeRole",draft:!1,unlisted:!1,editUrl:"https://github.com/kubernetes-sigs/headlamp/edit/main/docs/development/api/lib/k8s/role/interfaces/KubeRole.md",tags:[],version:"current",frontMatter:{},sidebar:"mainSidebar",previous:{title:"Class: Role",permalink:"/docs/latest/development/api/lib/k8s/role/classes/Role"},next:{title:"lib/k8s/roleBinding",permalink:"/docs/latest/development/api/lib/k8s/roleBinding/API"}},d={},a=[{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:"rules",id:"rules",level:3},{value:"apiGroups",id:"apigroups",level:4},{value:"nonResourceURLs",id:"nonresourceurls",level:4},{value:"resourceNames",id:"resourcenames",level:4},{value:"resources",id:"resources",level:4},{value:"verbs",id:"verbs",level:4},{value:"spec?",id:"spec",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"status?",id:"status",level:3},{value:"Inherited from",id:"inherited-from-8",level:4}];function h(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,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"interface-kuberole",children:"Interface: KubeRole"}),"\n",(0,i.jsxs)(s.p,{children:["Defined in: ",(0,i.jsx)(s.a,{href:"https://github.com/kubernetes-sigs/headlamp/blob/9cb8e9a311f736f645f4a06f251f59bddca3cf60/frontend/src/lib/k8s/role.ts#L20",children:"lib/k8s/role.ts:20"})]}),"\n",(0,i.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,i.jsx)(s.h2,{id:"extends",children:"Extends"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface",children:(0,i.jsx)(s.code,{children:"KubeObjectInterface"})})}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"indexable",children:"Indexable"}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-ts",children:"[otherProps: string]: any\n"})}),"\n",(0,i.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(s.h3,{id:"actiontype",children:"actionType?"}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-ts",children:"optional actionType?: any;\n"})}),"\n",(0,i.jsxs)(s.p,{children:["Defined in: ",(0,i.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,i.jsx)(s.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface",children:(0,i.jsx)(s.code,{children:"KubeObjectInterface"})}),".",(0,i.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface#actiontype",children:(0,i.jsx)(s.code,{children:"actionType"})})]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"apiversion",children:"apiVersion?"}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-ts",children:"optional apiVersion?: string;\n"})}),"\n",(0,i.jsxs)(s.p,{children:["Defined in: ",(0,i.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,i.jsx)(s.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface",children:(0,i.jsx)(s.code,{children:"KubeObjectInterface"})}),".",(0,i.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface#apiversion",children:(0,i.jsx)(s.code,{children:"apiVersion"})})]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"items",children:"items?"}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-ts",children:"optional items?: any[];\n"})}),"\n",(0,i.jsxs)(s.p,{children:["Defined in: ",(0,i.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,i.jsx)(s.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface",children:(0,i.jsx)(s.code,{children:"KubeObjectInterface"})}),".",(0,i.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface#items",children:(0,i.jsx)(s.code,{children:"items"})})]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"key",children:"key?"}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-ts",children:"optional key?: any;\n"})}),"\n",(0,i.jsxs)(s.p,{children:["Defined in: ",(0,i.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,i.jsx)(s.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface",children:(0,i.jsx)(s.code,{children:"KubeObjectInterface"})}),".",(0,i.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface#key",children:(0,i.jsx)(s.code,{children:"key"})})]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"kind",children:"kind"}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-ts",children:"kind: string;\n"})}),"\n",(0,i.jsxs)(s.p,{children:["Defined in: ",(0,i.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,i.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,i.jsx)(s.p,{children:"In CamelCase."}),"\n",(0,i.jsx)(s.p,{children:"Cannot be updated."}),"\n",(0,i.jsx)(s.h4,{id:"see",children:"See"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",children:"more info"})}),"\n",(0,i.jsx)(s.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface",children:(0,i.jsx)(s.code,{children:"KubeObjectInterface"})}),".",(0,i.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface#kind",children:(0,i.jsx)(s.code,{children:"kind"})})]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"lasttimestamp",children:"lastTimestamp?"}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-ts",children:"optional lastTimestamp?: string;\n"})}),"\n",(0,i.jsxs)(s.p,{children:["Defined in: ",(0,i.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,i.jsx)(s.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface",children:(0,i.jsx)(s.code,{children:"KubeObjectInterface"})}),".",(0,i.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface#lasttimestamp",children:(0,i.jsx)(s.code,{children:"lastTimestamp"})})]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"metadata",children:"metadata"}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-ts",children:"metadata: KubeMetadata;\n"})}),"\n",(0,i.jsxs)(s.p,{children:["Defined in: ",(0,i.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,i.jsx)(s.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface",children:(0,i.jsx)(s.code,{children:"KubeObjectInterface"})}),".",(0,i.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface#metadata",children:(0,i.jsx)(s.code,{children:"metadata"})})]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"rules",children:"rules"}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-ts",children:"rules: object[];\n"})}),"\n",(0,i.jsxs)(s.p,{children:["Defined in: ",(0,i.jsx)(s.a,{href:"https://github.com/kubernetes-sigs/headlamp/blob/9cb8e9a311f736f645f4a06f251f59bddca3cf60/frontend/src/lib/k8s/role.ts#L21",children:"lib/k8s/role.ts:21"})]}),"\n",(0,i.jsx)(s.h4,{id:"apigroups",children:"apiGroups"}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-ts",children:"apiGroups: string[];\n"})}),"\n",(0,i.jsx)(s.h4,{id:"nonresourceurls",children:"nonResourceURLs"}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-ts",children:"nonResourceURLs: string[];\n"})}),"\n",(0,i.jsx)(s.h4,{id:"resourcenames",children:"resourceNames"}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-ts",children:"resourceNames: string[];\n"})}),"\n",(0,i.jsx)(s.h4,{id:"resources",children:"resources"}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-ts",children:"resources: string[];\n"})}
1),"\n",(0,i.jsx)(s.h4,{id:"verbs",children:"verbs"}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-ts",children:"verbs: string[];\n"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"spec",children:"spec?"}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-ts",children:"optional spec?: any;\n"})}),"\n",(0,i.jsxs)(s.p,{children:["Defined in: ",(0,i.jsx)(s.a,{href:"https://github.com/kubernetes-sigs/headlamp/blob/9cb8e9a311f736f645f4a06f251f59bddca3cf60/frontend/src/lib/k8s/KubeObject.ts#L784",children:"lib/k8s/KubeObject.ts:784"})]}),"\n",(0,i.jsx)(s.h4,{id:"inherited-from-7",children:"Inherited from"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface",children:(0,i.jsx)(s.code,{children:"KubeObjectInterface"})}),".",(0,i.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface#spec",children:(0,i.jsx)(s.code,{children:"spec"})})]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"status",children:"status?"}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-ts",children:"optional status?: any;\n"})}),"\n",(0,i.jsxs)(s.p,{children:["Defined in: ",(0,i.jsx)(s.a,{href:"https://github.com/kubernetes-sigs/headlamp/blob/9cb8e9a311f736f645f4a06f251f59bddca3cf60/frontend/src/lib/k8s/KubeObject.ts#L785",children:"lib/k8s/KubeObject.ts:785"})]}),"\n",(0,i.jsx)(s.h4,{id:"inherited-from-8",children:"Inherited from"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface",children:(0,i.jsx)(s.code,{children:"KubeObjectInterface"})}),".",(0,i.jsx)(s.a,{href:"/docs/latest/development/api/lib/k8s/KubeObject/interfaces/KubeObjectInterface#status",children:(0,i.jsx)(s.code,{children:"status"})})]})]})}function o(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},28453:(e,s,n)=>{n.d(s,{R:()=>c,x:()=>l});var i=n(96540);const t={},r=i.createContext(t);function c(e){const s=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),i.createElement(r.Provider,{value:s},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.