Namespace: Catalog#
Common.Catalog
Table of contents#
Classes#
Interfaces#
- CatalogCategoryEvents
- CatalogCategoryMetadata
- CatalogCategorySpec
- CatalogCategoryVersion
- CatalogEntityActionContext
- CatalogEntityAddMenu
- CatalogEntityAddMenuContext
- CatalogEntityContextMenu
- CatalogEntityContextMenuContext
- CatalogEntityContextMenuNavigate
- CatalogEntityData
- CatalogEntityKindData
- CatalogEntityMetadata
- CatalogEntitySettingsContext
- CatalogEntitySettingsMenu
- CatalogEntityStatus
- KubernetesClusterMetadata
- KubernetesClusterPrometheusMetrics
- KubernetesClusterSpec
- KubernetesClusterStatus
- WebLinkSpec
- WebLinkStatus
Type Aliases#
- AddMenuFilter
- CatalogEntityConstructor
- CatalogEntityDataFor
- CatalogEntityInstanceFrom
- CatalogEntitySpec
- EntityMetadataObject
- EntityMetadataValue
- KubernetesClusterStatusPhase
- WebLinkStatusPhase
Variables#
Functions#
Type Aliases#
AddMenuFilter#
Ƭ AddMenuFilter: (menu: CatalogEntityAddMenu) => any
Type declaration#
▸ (menu): any
If the filter return a thruthy value, the menu item is displayed
Parameters#
| Name | Type |
|---|---|
menu |
CatalogEntityAddMenu |
Returns#
any
CatalogEntityConstructor#
Ƭ CatalogEntityConstructor<Entity>: (data: CatalogEntityDataFor<Entity>) => Entity
Type parameters#
| Name | Type |
|---|---|
Entity |
extends CatalogEntity |
Type declaration#
• (data)
Parameters#
| Name | Type |
|---|---|
data |
CatalogEntityDataFor<Entity> |
CatalogEntityDataFor#
Ƭ CatalogEntityDataFor<Entity>: Entity extends CatalogEntity<infer Metadata, infer Status, infer Spec> ? CatalogEntityData<Metadata, Status, Spec> : never
Type parameters#
| Name |
|---|
Entity |
CatalogEntityInstanceFrom#
Ƭ CatalogEntityInstanceFrom<Constructor>: Constructor extends CatalogEntityConstructor<infer Entity> ? Entity : never
Type parameters#
| Name |
|---|
Constructor |
CatalogEntitySpec#
Ƭ CatalogEntitySpec: Record<string, any>
EntityMetadataObject#
Ƭ EntityMetadataObject: { [Key in string]?: EntityMetadataValue }
EntityMetadataValue#
Ƭ EntityMetadataValue: string | number | boolean | EntityMetadataObject | undefined
KubernetesClusterStatusPhase#
Ƭ KubernetesClusterStatusPhase: "connected" | "connecting" | "disconnected" | "deleting"
deprecated This is no longer used as it is incorrect. Other sources can add more values
WebLinkStatusPhase#
Ƭ WebLinkStatusPhase: "available" | "unavailable"
Variables#
kubernetesClusterCategory#
• Const kubernetesClusterCategory: KubernetesClusterCategory
Functions#
categoryVersion#
▸ categoryVersion<T, Metadata, Status, Spec>(name, entityClass): CatalogCategoryVersion
Type parameters#
| Name | Type |
|---|---|
T |
extends CatalogEntity<Metadata, Status, Spec, T> |
Metadata |
extends CatalogEntityMetadata<Metadata> |
Status |
extends CatalogEntityStatus |
Spec |
extends CatalogEntitySpec |
Parameters#
| Name | Type |
|---|---|
name |
string |
entityClass |
(data: CatalogEntityData<Metadata, Status, Spec>) => T |