Skip to content

Class: ClusterRole#

Hierarchy#

↳ Role

↳ ClusterRole

Implements#

  • ItemObject

Index#

Constructors#

Properties#

Accessors#

Methods#

Constructors#

constructor#

+ new ClusterRole(data: KubeJsonApiData): ClusterRole

Inherited from KubeObject.constructor

Defined in src/renderer/api/kube-object.ts:154

Parameters:

Name Type
data KubeJsonApiData

Returns: ClusterRole

Properties#

apiVersion#

• apiVersion: string

Inherited from KubeObject.apiVersion

Defined in src/renderer/api/kube-object.ts:160

kind#

• kind: string

Inherited from KubeObject.kind

Defined in src/renderer/api/kube-object.ts:161

metadata#

• metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

Defined in src/renderer/api/kube-object.ts:162

rules#

• rules: object[]

Inherited from Role.rules

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:163

Static apiBase#

▪ apiBase: string = "/apis/rbac.authorization.k8s.io/v1/clusterroles"

Overrides Role.apiBase

Defined in src/renderer/api/endpoints/cluster-role.api.ts:9

Static kind#

▪ kind: string = "ClusterRole"

Overrides Role.kind

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#

• get selfLink(): string

Inherited from KubeObject.selfLink

Defined in src/renderer/api/kube-object.ts:165

Returns: string

Methods#

delete#

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

Inherited from KubeObject.delete

Defined in src/renderer/api/kube-object.ts:254

Parameters:

Name Type
params? JsonApiParams

Returns: Promise‹KubeJsonApiData›

getAge#

▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

Inherited from KubeObject.getAge

Defined in src/renderer/api/kube-object.ts:190

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:211

Parameters:

Name Type Default
filter boolean false

Returns: string[]

getFinalizers#

▸ getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

Defined in src/renderer/api/kube-object.ts:203

Returns: string[]

getId#

▸ getId(): string

Inherited from KubeObject.getId

Defined in src/renderer/api/kube-object.ts:169

Returns: string

getLabels#

▸ getLabels(): string[]

Inherited from KubeObject.getLabels

Defined in src/renderer/api/kube-object.ts:207

Returns: string[]

getName#

▸ getName(): string

Inherited from KubeObject.getName

Defined in src/renderer/api/kube-object.ts:177

Returns: string

getNs#

▸ getNs(): string

Inherited from KubeObject.getNs

Defined in src/renderer/api/kube-object.ts:181

Returns: string

getOwnerRefs#

▸ getOwnerRefs(): object[]

Inherited from KubeObject.getOwnerRefs

Defined in src/renderer/api/kube-object.ts:221

Returns: object[]

getResourceVersion#

▸ getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

Defined in src/renderer/api/kube-object.ts:173

Returns: string

getRules#

▸ getRules(): object[]

Inherited from Role.getRules

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:230

Returns: string[]

getTimeDiffFromNow#

▸ getTimeDiffFromNow(): number

Inherited from KubeObject.getTimeDiffFromNow

Defined in src/renderer/api/kube-object.ts:186

Returns: number

toPlainObject#

▸ toPlainObject(): object

Inherited from KubeObject.toPlainObject

Defined in src/renderer/api/kube-object.ts:242

Returns: object

update#

▸ update‹T›(data: Partial‹T›): Promise‹T›

Inherited from KubeObject.update

Defined in src/renderer/api/kube-object.ts:247

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:74

Parameters:

Name Type
data any

Returns: KubeObject‹›

Static isJsonApiData#

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

Defined in src/renderer/api/kube-object.ts:82

Parameters:

Name Type
object unknown

Returns: object is KubeJsonApiData

Static isJsonApiDataList#

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

Inherited from KubeObject.isJsonApiDataList

Defined in src/renderer/api/kube-object.ts:140

Type parameters:

▪ T

Parameters:

▪ object: unknown

▪ verifyItem: function

▸ (val: unknown): val is T

Parameters:

Name Type
val unknown

Returns: object is KubeJsonApiDataList‹T›

Static isKubeJsonApiListMetadata#

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

Inherited from KubeObject.isKubeJsonApiListMetadata

Defined in src/renderer/api/kube-object.ts:91

Parameters:

Name Type
object unknown

Returns: object is KubeJsonApiListMetadata

Static isKubeJsonApiMetadata#

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

Inherited from KubeObject.isKubeJsonApiMetadata

Defined in src/renderer/api/kube-object.ts:99

Parameters:

Name Type
object unknown

Returns: object is KubeJsonApiMetadata

Static isNonSystem#

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

Defined in src/renderer/api/kube-object.ts:78

Parameters:

Name Type
item KubeJsonApiData | KubeObject

Returns: boolean

Static isPartialJsonApiData#

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

Inherited from KubeObject.isPartialJsonApiData

Defined in src/renderer/api/kube-object.ts:131

Parameters:

Name Type
object unknown

Returns: object is Partial‹KubeJsonApiData›

Static isPartialJsonApiMetadata#

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

Inherited from KubeObject.isPartialJsonApiMetadata

Defined in src/renderer/api/kube-object.ts:115

Parameters:

Name Type
object unknown

Returns: object is Partial‹KubeJsonApiMetadata›

Static stringifyLabels#

▸ stringifyLabels(labels?: object): string[]

Inherited from KubeObject.stringifyLabels

Defined in src/renderer/api/kube-object.ts:150

Parameters:

Name Type
labels? object

Returns: string[]