From 1f4284ab150fe4e63e48103124ef8178f94b34ae Mon Sep 17 00:00:00 2001
From: GitHub Action • The group and version of this class. CatalogEntityKindData.apiVersion • A DNS label name of the entity. ▸ getId(): Get the UID of this entity ▸ getName(): Get the name of this entity ▸ getSource(): Get the specified source of this entity, defaulting to ▸ isEnabled(): Get if this entity is enabled. ▸
Properties#
apiVersion#
Readonly Abstract apiVersion: stringImplementation of#
kind#
Readonly Abstract kind: stringImplementation of#
@@ -1002,14 +1020,29 @@
Methods#
getId#
stringReturns#
string
getName#
stringReturns#
string
+getSource#
+string"unknown" if not
+providedReturns#
+string
+isEnabled#
+booleanReturns#
+boolean
onContextMenuOpen#
Abstract onContextMenuOpen(context): void | Promise<void>Parameters#
@@ -1027,7 +1060,7 @@
-Returns#
+Returns#
void | Promise<void>
onRun#
@@ -1047,7 +1080,7 @@
-Returns#
+Returns#
void | Promise<void>
onSettingsOpen#
@@ -1067,7 +1100,7 @@
-Returns#
+Returns#
void | Promise<void>
• Readonly apiVersion: "entity.k8slens.dev/v1alpha1"
The group and version of this class.
• Readonly kind: "General"
A DNS label name of the entity.
▸ getId(): string
Get the UID of this entity
string
▸ getName(): string
Get the name of this entity
string
▸ getSource(): string
Get the specified source of this entity, defaulting to "unknown" if not
+provided
string
▸ isEnabled(): boolean
Get if this entity is enabled.
+boolean
▸ onContextMenuOpen(): void
void
CatalogEntity.onContextMenuOpen
▸ onDetailsOpen(): void
void
▸ onRun(): Promise<void>
Promise<void>
▸ onSettingsOpen(): void
void
• Readonly apiVersion: "entity.k8slens.dev/v1alpha1"
The group and version of this class.
• Readonly kind: "KubernetesCluster"
A DNS label name of the entity.
▸ getId(): string
Get the UID of this entity
string
▸ getName(): string
Get the name of this entity
string
▸ getSource(): string
Get the specified source of this entity, defaulting to "unknown" if not
+provided
string
▸ isEnabled(): boolean
Get if this entity is enabled.
+boolean
▸ onContextMenuOpen(context): Promise<void>
Promise<void>
CatalogEntity.onContextMenuOpen
▸ onDetailsOpen(): void
void
Promise<void>
▸ onSettingsOpen(): void
void
• Readonly apiVersion: "entity.k8slens.dev/v1alpha1"
The group and version of this class.
• Readonly kind: "WebLink"
A DNS label name of the entity.
▸ getId(): string
Get the UID of this entity
string
▸ getName(): string
Get the name of this entity
string
▸ getSource(): string
Get the specified source of this entity, defaulting to "unknown" if not
+provided
string
▸ isEnabled(): boolean
Get if this entity is enabled.
+boolean
▸ onContextMenuOpen(context): Promise<void>
Promise<void>
CatalogEntity.onContextMenuOpen
▸ onRun(): Promise<void>
Promise<void>
▸ onSettingsOpen(): void
void
• Readonly [IpcPrefix]: string
IpcRegistrar.__@IpcPrefix@44702
+IpcRegistrar.__@IpcPrefix@44722
• Protected extension: LensExtension
• [Disposers]: ExtendableDisposer
LensExtension.__@Disposers@30326
+LensExtension.__@Disposers@30346
• appMenus: MenuRegistration[] = []
• Readonly [IpcPrefix]: string
IpcRegistrar.__@IpcPrefix@44702
+IpcRegistrar.__@IpcPrefix@44722
• Protected extension: LensExtension
• [Disposers]: ExtendableDisposer
LensExtension.__@Disposers@30326
+LensExtension.__@Disposers@30346
• appPreferences: AppPreferenceRegistration[] = []
• group: string
The grouping for for the category. This MUST be a DNS label.
• names: Object
kindstringkind fields that are produced by the .versions.[] | .entityClass fields.• versions: CatalogCategoryVersion<CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>>[]
The specific versions of the constructors.
+NOTE: the field .apiVersion after construction MUST match {.group}/{.versions.[] | .name}.
+For example, if group = "entity.k8slens.dev" and there is an entry in .versions with
+name = "v1alpha1" then the resulting .apiVersion MUST be entity.k8slens.dev/v1alpha1
• entityClass: CatalogEntityConstructor<Entity>
The constructor for the entities.
• name: string
The specific version that the associated constructor is for. This MUST be
+a DNS label and SHOULD be of the form vN, vNalphaY, or vNbetaY where
+N and Y are both integers greater than 0.
Examples: The following are valid values for this field.
+- v1
+- v1beta1
+- v1alpha2
+- v3beta2
• name: string
• Optional shortName: string
• Optional source: string
• Optional shortName: string
CatalogEntityMetadata.shortName
+• Optional source: string
• uid: string