@k8slens/extensions / Exports / Common / Catalog / KubernetesCluster

Class: KubernetesCluster<Metadata, Status, Spec>

Common.Catalog.KubernetesCluster

Type parameters

Name	Type
Metadata	extends KubernetesClusterMetadata = KubernetesClusterMetadata
Status	extends KubernetesClusterStatus = KubernetesClusterStatus
Spec	extends KubernetesClusterSpec = KubernetesClusterSpec

Hierarchy

• CatalogEntity<Metadata, Status, Spec>

↳ KubernetesCluster

Table of contents

Constructors

• constructor

Properties

• apiVersion
• kind
• metadata
• spec
• status
• apiVersion
• kind

Methods

• connect
• disconnect
• getId
• getName
• getSource
• isEnabled
• onContextMenuOpen
• onDetailsOpen
• onRun
• onSettingsOpen

Constructors

constructor

• new KubernetesCluster<Metadata, Status, Spec>(«destructured»)

Type parameters

Name	Type
Metadata	extends KubernetesClusterMetadata<Metadata> = KubernetesClusterMetadata
Status	extends KubernetesClusterStatus = KubernetesClusterStatus
Spec	extends KubernetesClusterSpec<Spec> = KubernetesClusterSpec

Parameters

Name	Type
«destructured»	CatalogEntityData<Metadata, Status, Spec>

Inherited from

CatalogEntity.constructor

Properties

apiVersion

• Readonly apiVersion: string

The group and version of this class.

Overrides

CatalogEntity.apiVersion

---

kind

• Readonly kind: string

A DNS label name of the entity.

Overrides

CatalogEntity.kind

---

metadata

• metadata: Metadata

Inherited from

CatalogEntity.metadata

---

spec

• spec: Spec

Inherited from

CatalogEntity.spec

---

status

• status: Status

Inherited from

CatalogEntity.status

---

apiVersion

▪ Static Readonly apiVersion: string

---

kind

▪ Static Readonly kind: string

Methods

connect

▸ connect(): Promise<void>

Returns

Promise<void>

---

disconnect

▸ disconnect(): Promise<void>

Returns

Promise<void>

---

getId

▸ getId(): string

Get the UID of this entity

Returns

string

Inherited from

CatalogEntity.getId

---

getName

▸ getName(): string

Get the name of this entity

Returns

string

Inherited from

CatalogEntity.getName

---

getSource

▸ getSource(): string

Get the specified source of this entity, defaulting to "unknown" if not provided

Returns

string

Inherited from

CatalogEntity.getSource

---

isEnabled

▸ isEnabled(): boolean

Get if this entity is enabled.

Returns

boolean

Inherited from

CatalogEntity.isEnabled

---

onContextMenuOpen

▸ onContextMenuOpen(context): void

Parameters

Name	Type
context	CatalogEntityContextMenuContext

Returns

void

Overrides

CatalogEntity.onContextMenuOpen

---

onDetailsOpen

▸ onDetailsOpen(): void

Returns

void

---

onRun

▸ onRun(context): Promise<void>

Parameters

Name	Type
context	CatalogEntityActionContext

Returns

Promise<void>

Overrides

CatalogEntity.onRun

---

onSettingsOpen

▸ onSettingsOpen(): void

Returns

void

Overrides

CatalogEntity.onSettingsOpen