Class: ClusterRole#
Hierarchy#
↳ Role
↳ ClusterRole
Implements#
- ItemObject
Index#
Constructors#
Properties#
Accessors#
Methods#
- delete
- getAge
- getAnnotations
- getFinalizers
- getId
- getLabels
- getName
- getNs
- getOwnerRefs
- getResourceVersion
- getRules
- getSearchFields
- toPlainObject
- update
- create
- isJsonApiData
- isJsonApiDataList
- isNonSystem
- stringifyLabels
Constructors#
constructor#
+ new ClusterRole(data
: KubeJsonApiData): ClusterRole
Inherited from KubeObject.constructor
Defined in src/renderer/api/kube-object.ts:93
Parameters:
Name | Type |
---|---|
data |
KubeJsonApiData |
Returns: ClusterRole
Properties#
apiVersion#
• apiVersion: string
Inherited from KubeObject.apiVersion
Defined in src/renderer/api/kube-object.ts:99
kind#
• kind: string
Inherited from KubeObject.kind
Defined in src/renderer/api/kube-object.ts:100
metadata#
• metadata: IKubeObjectMetadata
Inherited from KubeObject.metadata
Defined in src/renderer/api/kube-object.ts:101
rules#
• rules: object[]
Defined in src/renderer/api/endpoints/role.api.ts:9
Optional
status#
• status? : any
Inherited from KubeObject.status
Defined in src/renderer/api/kube-object.ts:102
Static
apiBase#
▪ apiBase: string = "/apis/rbac.authorization.k8s.io/v1/clusterroles"
Defined in src/renderer/api/endpoints/cluster-role.api.ts:9
Static
kind#
▪ kind: string = "ClusterRole"
Defined in src/renderer/api/endpoints/cluster-role.api.ts:7
Static
namespaced#
▪ namespaced: boolean = false
Overrides Role.namespaced
Defined in src/renderer/api/endpoints/cluster-role.api.ts:8
Accessors#
selfLink#
• get selfLink(): string
Inherited from KubeObject.selfLink
Defined in src/renderer/api/kube-object.ts:104
Returns: string
Methods#
delete#
▸ delete(params?
: JsonApiParams): CancelablePromise‹KubeJsonApiData›
Inherited from KubeObject.delete
Defined in src/renderer/api/kube-object.ts:190
Parameters:
Name | Type |
---|---|
params? |
JsonApiParams |
Returns: CancelablePromise‹KubeJsonApiData›
getAge#
▸ getAge(humanize
: boolean, compact
: boolean, fromNow
: boolean): string | number
Inherited from KubeObject.getAge
Defined in src/renderer/api/kube-object.ts:126
Parameters:
Name | Type | Default |
---|---|---|
humanize |
boolean | true |
compact |
boolean | true |
fromNow |
boolean | false |
Returns: string | number
getAnnotations#
▸ getAnnotations(filter
: boolean): string[]
Inherited from KubeObject.getAnnotations
Defined in src/renderer/api/kube-object.ts:147
Parameters:
Name | Type | Default |
---|---|---|
filter |
boolean | false |
Returns: string[]
getFinalizers#
▸ getFinalizers(): string[]
Inherited from KubeObject.getFinalizers
Defined in src/renderer/api/kube-object.ts:139
Returns: string[]
getId#
▸ getId(): string
Inherited from KubeObject.getId
Defined in src/renderer/api/kube-object.ts:108
Returns: string
getLabels#
▸ getLabels(): string[]
Inherited from KubeObject.getLabels
Defined in src/renderer/api/kube-object.ts:143
Returns: string[]
getName#
▸ getName(): string
Inherited from KubeObject.getName
Defined in src/renderer/api/kube-object.ts:116
Returns: string
getNs#
▸ getNs(): string
Inherited from KubeObject.getNs
Defined in src/renderer/api/kube-object.ts:120
Returns: string
getOwnerRefs#
▸ getOwnerRefs(): object[]
Inherited from KubeObject.getOwnerRefs
Defined in src/renderer/api/kube-object.ts:157
Returns: object[]
getResourceVersion#
▸ getResourceVersion(): string
Inherited from KubeObject.getResourceVersion
Defined in src/renderer/api/kube-object.ts:112
Returns: string
getRules#
▸ getRules(): object[]
Defined in src/renderer/api/endpoints/role.api.ts:16
Returns: object[]
getSearchFields#
▸ getSearchFields(): string[]
Inherited from KubeObject.getSearchFields
Defined in src/renderer/api/kube-object.ts:166
Returns: string[]
toPlainObject#
▸ toPlainObject(): object
Inherited from KubeObject.toPlainObject
Defined in src/renderer/api/kube-object.ts:178
Returns: object
update#
▸ update‹T›(data
: Partial‹T›): Promise‹T›
Inherited from KubeObject.update
Defined in src/renderer/api/kube-object.ts:183
Type parameters:
▪ T: KubeObject
Parameters:
Name | Type |
---|---|
data |
Partial‹T› |
Returns: Promise‹T›
Static
create#
▸ create(data
: any): KubeObject‹›
Inherited from KubeObject.create
Defined in src/renderer/api/kube-object.ts:73
Parameters:
Name | Type |
---|---|
data |
any |
Returns: KubeObject‹›
Static
isJsonApiData#
▸ isJsonApiData(object
: any): object is KubeJsonApiData
Inherited from KubeObject.isJsonApiData
Defined in src/renderer/api/kube-object.ts:81
Parameters:
Name | Type |
---|---|
object |
any |
Returns: object is KubeJsonApiData
Static
isJsonApiDataList#
▸ isJsonApiDataList(object
: any): object is KubeJsonApiDataList
Inherited from KubeObject.isJsonApiDataList
Defined in src/renderer/api/kube-object.ts:85
Parameters:
Name | Type |
---|---|
object |
any |
Returns: object is KubeJsonApiDataList
Static
isNonSystem#
▸ isNonSystem(item
: KubeJsonApiData | KubeObject): boolean
Inherited from KubeObject.isNonSystem
Defined in src/renderer/api/kube-object.ts:77
Parameters:
Name | Type |
---|---|
item |
KubeJsonApiData | KubeObject |
Returns: boolean
Static
stringifyLabels#
▸ stringifyLabels(labels
: object): string[]
Inherited from KubeObject.stringifyLabels
Defined in src/renderer/api/kube-object.ts:89
Parameters:
Name | Type |
---|---|
labels |
object |
Returns: string[]