Skip to content

Class: KubernetesCluster<Metadata, Status, Spec>#

Common.Catalog.KubernetesCluster

Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.

Type parameters#

Name Type
Metadata extends KubernetesClusterMetadataKubernetesClusterMetadata
Status extends KubernetesClusterStatusKubernetesClusterStatus
Spec extends KubernetesClusterSpecKubernetesClusterSpec

Hierarchy#

↳ KubernetesCluster

Table of contents#

Constructors#

Properties#

Methods#

Constructors#

constructor#

• new KubernetesCluster<Metadata, Status, Spec>(__namedParameters)

Type parameters#

Name Type
Metadata extends KubernetesClusterMetadataKubernetesClusterMetadata
Status extends KubernetesClusterStatusKubernetesClusterStatus
Spec extends KubernetesClusterSpec<Spec>KubernetesClusterSpec

Parameters#

Name Type
__namedParameters CatalogEntityData<Metadata, Status, Spec>

Inherited from#

CatalogEntity.constructor

Properties#

apiVersion#

• Readonly apiVersion: string = KubernetesCluster.apiVersion

The group and version of this class.

Overrides#

CatalogEntity.apiVersion


kind#

• Readonly kind: string = KubernetesCluster.kind

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 = "entity.k8slens.dev/v1alpha1"


kind#

▪ Static Readonly kind: string = "KubernetesCluster"

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): Promise<void>

Parameters#

Name Type
context CatalogEntityContextMenuContext

Returns#

Promise<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