Skip to content

cmem_client.models.workspace_config¤

Corporate Memory Explore workspace configuration models.

This module defines models for representing workspace configurations managed by the DataPlatform (explore) Workspace Config Controller API.

Classes:

LocalizedString¤

Bases: Model

A language-tagged string value.

Attributes:

  • value (str) – Text of the string.
  • lang (str) – Language tag the text is written in, e.g. en.

lang¤

lang: str

model_config¤

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

value¤

value: str

WorkspaceConfig¤

Bases: ReadRepositoryItem

An Explore (DataPlatform) workspace configuration.

Attributes:

  • id (str) – ID of the configuration. This is the key of the repository.
  • labels (list[LocalizedString]) – Names of the workspace, one per language. Use the label property to pick one without handling the list yourself.
  • enable_companion (bool | None) – Whether the companion is enabled, or None if the configuration does not decide it and the deployment default applies.
  • enable_graph_insights (bool | None) – Whether Graph Insights is enabled, or None if the configuration does not decide it.

Functions:

  • get_id – Get the ID of the workspace configuration.

enable_companion¤

enable_companion: bool | None = Field(alias='enableCompanion', default=None)

enable_graph_insights¤

enable_graph_insights: bool | None = Field(alias='enableGraphInsights', default=None)

get_id¤

get_id()

Get the ID of the workspace configuration.

id¤

id: str

label¤

label: str

Get the English label, falling back to first available or the ID.

labels¤

labels: list[LocalizedString] = Field(default=[LocalizedString(value='This is a default workspace label', lang='en')])

model_config¤

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

Comments