Skip to content

Class: GeneralEntity#

Common.Catalog.GeneralEntity

Hierarchy#

↳ GeneralEntity

Table of contents#

Constructors#

Properties#

Methods#

Constructors#

constructor#

• new GeneralEntity(__namedParameters)

Parameters#

Name Type
__namedParameters CatalogEntityData<CatalogEntityMetadata, CatalogEntityStatus, GeneralEntitySpec>

Inherited from#

CatalogEntity.constructor

Properties#

apiVersion#

• Readonly apiVersion: "entity.k8slens.dev/v1alpha1"

The group and version of this class.

Overrides#

CatalogEntity.apiVersion

kind#

• Readonly kind: "General"

A DNS label name of the entity.

Overrides#

CatalogEntity.kind

metadata#

• metadata: CatalogEntityMetadata

Inherited from#

CatalogEntity.metadata

spec#

• spec: GeneralEntitySpec

Inherited from#

CatalogEntity.spec

status#

• status: CatalogEntityStatus

Inherited from#

CatalogEntity.status

Methods#

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#

▸ Optional onContextMenuOpen(context): void | Promise<void>

Parameters#

Name Type
context CatalogEntityContextMenuContext

Returns#

void | Promise<void>

Inherited from#

CatalogEntity.onContextMenuOpen

onRun#

▸ onRun(): Promise<void>

Returns#

Promise<void>

Overrides#

CatalogEntity.onRun

onSettingsOpen#

▸ Optional onSettingsOpen(context): void | Promise<void>

Parameters#

Name Type
context CatalogEntitySettingsContext

Returns#

void | Promise<void>

Inherited from#

CatalogEntity.onSettingsOpen