Skip to content

cmem_client.models.workspace_plugin¤

Workspace plugin model.

A workspace plugin is a single plugin class DataIntegration discovered, as opposed to the Python package shipping it. client.python_packages.list_plugins() returns the plugins of all installed packages.

Classes:

  • WorkspacePlugin – A plugin installed in the Corporate Memory DataIntegration workspace.

WorkspacePlugin¤

Bases: ReadRepositoryItem

A plugin installed in the Corporate Memory DataIntegration workspace.

Attributes:

  • id (str) – Identifier of the plugin, unique within the deployment.
  • module_name (str) – Python module the plugin class was loaded from.
  • plugin_type (str) – Kind of plugin, e.g. WorkflowPlugin or TransformPlugin.
  • label (str) – Human readable name shown in the user interface.
  • is_registered (bool) – Whether DataIntegration registered the plugin successfully. A plugin which failed to load is reported with False.

Functions:

  • get_id – Get the plugin identifier.

get_id¤

get_id()

Get the plugin identifier.

id¤

id: str

is_registered¤

is_registered: bool = Field(alias='isRegistered', default=True)

label¤

label: str

model_config¤

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

module_name¤

module_name: str = Field(alias='moduleName')

plugin_type¤

plugin_type: str = Field(alias='pluginType')

Comments