@k8slens/extensions

Globals / "src/renderer/api/endpoints/cluster.api" / Cluster

Class: Cluster

Hierarchy

• KubeObject

↳ Cluster

Implements

• ItemObject

Index

Constructors

• constructor

Properties

• apiVersion
• kind
• metadata
• spec
• status
• apiBase
• kind
• namespaced

Accessors

• selfLink

Methods

• delete
• getAge
• getAnnotations
• getFinalizers
• getId
• getLabels
• getName
• getNs
• getOwnerRefs
• getResourceVersion
• getSearchFields
• getStatus
• toPlainObject
• update
• create
• isJsonApiData
• isJsonApiDataList
• isNonSystem
• stringifyLabels

Constructors

constructor

+ new Cluster(data: KubeJsonApiData): Cluster

Inherited from KubeObject.constructor

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

Parameters:

Name	Type
data	KubeJsonApiData

Returns: Cluster

Properties

apiVersion

• apiVersion: string

Inherited from KubeObject.apiVersion

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

---

kind

• kind: string

Inherited from KubeObject.kind

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

---

metadata

• metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

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

---

spec

• spec: { clusterNetwork?: { pods?: { cidrBlocks?: string[] } ; serviceDomain?: string ; services?: { cidrBlocks?: string[] } } ; providerSpec: { value: { profile: string } } }

Defined in src/renderer/api/endpoints/cluster.api.ts:57

Type declaration:

Name	Type
clusterNetwork?	{ pods?: { cidrBlocks?: string[] } ; serviceDomain?: string ; services?: { cidrBlocks?: string[] } }
providerSpec	{ value: { profile: string } }

---

status

• Optional status: { apiEndpoints: { host: string ; port: string }[] ; errorMessage?: string ; errorReason?: string ; providerStatus: { adminPassword?: string ; adminUser?: string ; kubeconfig?: string ; lensAddress?: string ; processState?: string } }

Overrides KubeObject.status

Defined in src/renderer/api/endpoints/cluster.api.ts:73

Type declaration:

Name	Type
apiEndpoints	{ host: string ; port: string }[]
errorMessage?	string
errorReason?	string
providerStatus	{ adminPassword?: string ; adminUser?: string ; kubeconfig?: string ; lensAddress?: string ; processState?: string }

---

apiBase

▪ Static apiBase: string = "/apis/cluster.k8s.io/v1alpha1/clusters"

Defined in src/renderer/api/endpoints/cluster.api.ts:55

---

kind

▪ Static kind: string = "Cluster"

Overrides KubeObject.kind

Defined in src/renderer/api/endpoints/cluster.api.ts:54

---

namespaced

▪ Static Readonly namespaced: boolean

Inherited from KubeObject.namespaced

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

Accessors

selfLink

• get selfLink(): string

Inherited from KubeObject.selfLink

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

Returns: string

Methods

delete

▸ delete(params?: JsonApiParams): CancelablePromise\<KubeJsonApiData>

Inherited from KubeObject.delete

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

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

Parameters:

Name	Type	Default value
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:121

Parameters:

Name	Type	Default value
filter	boolean	false

Returns: string[]

---

getFinalizers

▸ getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

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

Returns: string[]

---

getId

▸ getId(): string

Implementation of ItemObject

Inherited from KubeObject.getId

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

Returns: string

---

getLabels

▸ getLabels(): string[]

Inherited from KubeObject.getLabels

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

Returns: string[]

---

getName

▸ getName(): string

Implementation of ItemObject

Inherited from KubeObject.getName

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

Returns: string

---

getNs

▸ getNs(): string

Inherited from KubeObject.getNs

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

Returns: string

---

getOwnerRefs

▸ getOwnerRefs(): { namespace: string = this.getNs() }[]

Inherited from KubeObject.getOwnerRefs

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

Returns: { namespace: string = this.getNs() }[]

---

getResourceVersion

▸ getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

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

Returns: string

---

getSearchFields

▸ getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

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

Returns: string[]

---

getStatus

▸ getStatus(): ACTIVE | CREATING | REMOVING | ERROR

Defined in src/renderer/api/endpoints/cluster.api.ts:89

Returns: ACTIVE | CREATING | REMOVING | ERROR

---

toPlainObject

▸ toPlainObject(): object

Inherited from KubeObject.toPlainObject

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

Returns: object

---

update

▸ update\(data: Partial\): Promise\

Inherited from KubeObject.update

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

Type parameters:

Name	Type
T	KubeObject

Parameters:

Name	Type
data	Partial\

Returns: Promise\

---

create

▸ Staticcreate(data: any): KubeObject

Inherited from KubeObject.create

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

Parameters:

Name	Type
data	any

Returns: KubeObject

---

isJsonApiData

▸ StaticisJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

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

Parameters:

Name	Type
object	any

Returns: object is KubeJsonApiData

---

isJsonApiDataList

▸ StaticisJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

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

Parameters:

Name	Type
object	any

Returns: object is KubeJsonApiDataList

---

isNonSystem

▸ StaticisNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

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

Parameters:

Name	Type
item	KubeJsonApiData | KubeObject

Returns: boolean

---

stringifyLabels

▸ StaticstringifyLabels(labels: { [name:string]: string; }): string[]

Inherited from KubeObject.stringifyLabels

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

Parameters:

Name	Type
labels	{ [name:string]: string; }

Returns: string[]

---

Last update: November 10, 2020