Skip to content

cmem_client.models.status¤

Models for Corporate Memory aggregated status information.

Aggregates version and health metadata across the build (DataIntegration), explore (DataPlatform), shapes catalog, and graph store components.

Classes:

  • CmemLicense – Corporate Memory license metadata from the DataPlatform info payload.
  • ComponentStatus – Version and health of a single Corporate Memory component.
  • ExploreStatus – Status of the explore (DataPlatform) component, including raw actuator payload.
  • HealthState – Health state of a Corporate Memory component.
  • StatusInfo – Aggregated status across all Corporate Memory components.
  • StoreInfo – Graph store metadata embedded in the DataPlatform info payload.
  • StoreStatus – Status of the graph store backing the DataPlatform.
  • WorkspaceConfiguration – Workspace configuration metadata from the DataPlatform info payload.

Attributes:

CmemLicense¤

Bases: Model

Corporate Memory license metadata from the DataPlatform info payload.

Attributes:

  • edition (str | None) – License edition (e.g. ‘PEDAL’).
  • grace_date (str | None) – Date until which the license keeps working in grace period (ISO date string).
  • in_grace_period (bool) – Whether the CMEM license is currently within its grace period.
  • model_config –
  • valid_date (str | None) – Date until which the license is valid (ISO date string).

edition¤

edition: str | None = None

License edition (e.g. ‘PEDAL’).

grace_date¤

grace_date: str | None = Field(default=None, alias='graceDate')

Date until which the license keeps working in grace period (ISO date string).

in_grace_period¤

in_grace_period: bool = Field(default=False, alias='inGracePeriod')

Whether the CMEM license is currently within its grace period.

model_config¤

model_config = ConfigDict(extra='allow', populate_by_name=True)

valid_date¤

valid_date: str | None = Field(default=None, alias='validDate')

Date until which the license is valid (ISO date string).

ComponentStatus¤

Bases: Model

Version and health of a single Corporate Memory component.

Attributes:

  • error (str | None) – Captured error message if status retrieval failed; None otherwise.
  • health (HealthState) – Health state of the component.
  • model_config –
  • version (str) – Component version string as reported by its version/info endpoint.

error¤

error: str | None = None

Captured error message if status retrieval failed; None otherwise.

health¤

health: HealthState = HealthState.UNKNOWN

Health state of the component.

model_config¤

model_config = ConfigDict(extra='allow', populate_by_name=True)

version¤

version: str = 'UNKNOWN'

Component version string as reported by its version/info endpoint.

ExploreStatus¤

Bases: ComponentStatus

Status of the explore (DataPlatform) component, including raw actuator payload.

Attributes:

  • error (str | None) – Captured error message if status retrieval failed; None otherwise.
  • health (HealthState) – Health state of the component.
  • health_details (dict[str, Any] | None) – Raw payload of the DataPlatform /actuator/health endpoint (component breakdown).
  • info (dict[str, Any] | None) – Raw payload of the DataPlatform /actuator/info endpoint.
  • license (CmemLicense | None) – Typed CMEM license info, or None if not reported (DataPlatform < 24.1).
  • model_config –
  • store_info (StoreInfo | None) – Typed graph store info from the actuator payload, or None if absent.
  • version (str) – Component version string as reported by its version/info endpoint.
  • workspace_configuration (WorkspaceConfiguration | None) – Typed workspace configuration info, or None if absent.
  • workspaces_to_migrate (list[Any]) – Workspace IDs flagged by the DataPlatform as requiring configuration migration.

error¤

error: str | None = None

Captured error message if status retrieval failed; None otherwise.

health¤

health: HealthState = HealthState.UNKNOWN

Health state of the component.

health_details¤

health_details: dict[str, Any] | None = None

Raw payload of the DataPlatform /actuator/health endpoint (component breakdown).

info¤

info: dict[str, Any] | None = None

Raw payload of the DataPlatform /actuator/info endpoint.

license¤

license: CmemLicense | None

Typed CMEM license info, or None if not reported (DataPlatform < 24.1).

model_config¤

model_config = ConfigDict(extra='allow', populate_by_name=True)

store_info¤

store_info: StoreInfo | None

Typed graph store info from the actuator payload, or None if absent.

version¤

version: str = 'UNKNOWN'

Component version string as reported by its version/info endpoint.

workspace_configuration¤

workspace_configuration: WorkspaceConfiguration | None

Typed workspace configuration info, or None if absent.

workspaces_to_migrate¤

workspaces_to_migrate: list[Any]

Workspace IDs flagged by the DataPlatform as requiring configuration migration.

HealthState¤

Bases: StrEnum

Health state of a Corporate Memory component.

Functions:

  • parse – Map a raw health string to a HealthState.

Attributes:

DOWN¤

DOWN = 'DOWN'

UNKNOWN¤

UNKNOWN = 'UNKNOWN'

UP¤

UP = 'UP'

parse¤

parse(value)

Map a raw health string to a HealthState.

Treats only the literal “UP” as up; any other non-empty value is considered DOWN. Missing/empty values become UNKNOWN.

Returns:

SHAPES_CATALOG_VERSION_QUERY¤

SHAPES_CATALOG_VERSION_QUERY = 'PREFIX owl: <http://www.w3.org/2002/07/owl#>\nPREFIX : <https://vocab.eccenca.com/shacl/>\nSELECT ?version\nFROM :\nWHERE {\n  : owl:versionInfo ?version\n}\nORDER BY ASC(?version)\n'

SPARQL query used to read the shapes catalog version from the explore store.

StatusInfo¤

Bases: Model

Aggregated status across all Corporate Memory components.

Functions:

  • to_summary_dict – Render the documented admin status output contract as a plain dict.

Attributes:

build¤

build: ComponentStatus = Field(default_factory=ComponentStatus)

Status of the build (DataIntegration) component.

explore¤

explore: ExploreStatus = Field(default_factory=ExploreStatus)

Status of the explore (DataPlatform) component.

health¤

health: HealthState

Overall health: UP only if every component is UP, DOWN otherwise.

model_config¤

model_config = ConfigDict(extra='allow', populate_by_name=True)

shapes¤

shapes: ComponentStatus = Field(default_factory=ComponentStatus)

Status of the shapes catalog (queried from the explore store).

store¤

store: StoreStatus = Field(default_factory=StoreStatus)

Status of the graph store backing the DataPlatform.

to_summary_dict¤

to_summary_dict()

Render the documented admin status output contract as a plain dict.

Reproduces the structure historically consumed by cmemc’s admin status command (--raw, --key, overall.healthy) and its shell completion of status keys, sourced from this typed status model.

Returns:

  • dict – A dict with a build, explore, shapes, store and overall
  • dict – key, each holding the version and health of that component where available.

StoreInfo¤

Bases: Model

Graph store metadata embedded in the DataPlatform info payload.

Attributes:

  • license_expiration (str | None) – Graph store license expiration date (ISO date string), if reported.
  • model_config –
  • type (str) – Store implementation (e.g. ‘GRAPHDB’, ‘TENTRIS’).
  • version (str) – Store version string.

license_expiration¤

license_expiration: str | None = Field(default=None, alias='licenseExpiration')

Graph store license expiration date (ISO date string), if reported.

model_config¤

model_config = ConfigDict(extra='allow', populate_by_name=True)

type¤

type: str = 'STORE'

Store implementation (e.g. ‘GRAPHDB’, ‘TENTRIS’).

version¤

version: str = 'UNKNOWN'

Store version string.

StoreStatus¤

Bases: ComponentStatus

Status of the graph store backing the DataPlatform.

Attributes:

  • error (str | None) – Captured error message if status retrieval failed; None otherwise.
  • health (HealthState) – Health state of the component.
  • model_config –
  • type (str) – Store implementation (e.g. ‘GRAPHDB’, ‘TENTRIS’).
  • version (str) – Component version string as reported by its version/info endpoint.

error¤

error: str | None = None

Captured error message if status retrieval failed; None otherwise.

health¤

health: HealthState = HealthState.UNKNOWN

Health state of the component.

model_config¤

model_config = ConfigDict(extra='allow', populate_by_name=True)

type¤

type: str = 'STORE'

Store implementation (e.g. ‘GRAPHDB’, ‘TENTRIS’).

version¤

version: str = 'UNKNOWN'

Component version string as reported by its version/info endpoint.

WorkspaceConfiguration¤

Bases: Model

Workspace configuration metadata from the DataPlatform info payload.

Attributes:

model_config¤

model_config = ConfigDict(extra='allow', populate_by_name=True)

version¤

version: int | None = None

Workspace configuration version.

workspaces_to_migrate¤

workspaces_to_migrate: list[Any] = Field(default_factory=list, alias='workspacesToMigrate')

Workspaces flagged as requiring configuration migration.

The DataPlatform reports each entry as an object (e.g. with iri/label/version); the items are kept untyped because they are only used to detect whether a migration is pending.

Comments