Class: CatalogEntity<Metadata, Status, Spec>#

Common.Catalog.CatalogEntity

Type parameters#

Name	Type
`Metadata`	extends `CatalogEntityMetadata` = `CatalogEntityMetadata`
`Status`	extends `CatalogEntityStatus` = `CatalogEntityStatus`
`Spec`	extends `CatalogEntitySpec` = `CatalogEntitySpec`

Hierarchy#

CatalogEntity

↳ KubernetesCluster

↳ GeneralEntity

↳ WebLink

Implements#

CatalogEntityKindData

Table of contents#

Constructors#

constructor

Properties#

Methods#

Constructors#

constructor#

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

Type parameters#

Name	Type
`Metadata`	extends `CatalogEntityMetadata` = `CatalogEntityMetadata`
`Status`	extends `CatalogEntityStatus` = `CatalogEntityStatus`
`Spec`	extends `CatalogEntitySpec` = `CatalogEntitySpec`

Parameters#

Name	Type
`__namedParameters`	`CatalogEntityData`<`Metadata`, `Status`, `Spec`>

Properties#

apiVersion#

• Readonly Abstract apiVersion: string

The group and version of this class.

Implementation of#

CatalogEntityKindData.apiVersion

kind#

• Readonly Abstract kind: string

A DNS label name of the entity.

Implementation of#

CatalogEntityKindData.kind

metadata#

• metadata: Metadata

spec#

• spec: Spec

status#

• status: Status

Methods#

getId#

▸ getId(): string

Get the UID of this entity

Returns#

string

getName#

▸ getName(): string

Get the name of this entity

Returns#

string

getSource#

▸ getSource(): string

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

Returns#

string

isEnabled#

▸ isEnabled(): boolean

Get if this entity is enabled.

Returns#

boolean

onContextMenuOpen#

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

Parameters#

Name	Type
`context`	`CatalogEntityContextMenuContext`

Returns#

void | Promise<void>

onRun#

▸ Optional Abstract onRun(context): void | Promise<void>

Parameters#

Name	Type
`context`	`CatalogEntityActionContext`

Returns#

void | Promise<void>

onSettingsOpen#

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

Parameters#

Name	Type
`context`	`CatalogEntitySettingsContext`

Returns#

void | Promise<void>