Skip to content

cmem_client.components.build.component¤

Corporate Memory Build (DataIntegration) component.

The Build component bundles the operations of the Build service which are not collections of items: the workspace feature (import and export of the whole workspace, reload, access control configuration, marshalling plugins and the loading status) and the log buffer feature. Each feature lives in its own module of this package.

Classes:

  • Build – High-level interface for the Corporate Memory Build (DataIntegration) service.

Build¤

Build(client)

High-level interface for the Corporate Memory Build (DataIntegration) service.

Attributes:

  • workspace (BuildWorkspace) – The workspace feature, for operations on the whole DataIntegration workspace.
  • logs (BuildLogs) – The log buffer feature, for the most recent log lines of Build and the state of its buffer.

Functions:

  • get_health – Report version and health of the Build (DataIntegration) service.

Parameters:

  • client (Client) – A configured Corporate Memory client instance with authentication and endpoint configuration.

get_health¤

get_health()

Report version and health of the Build (DataIntegration) service.

Reads the service’s /version and /health.

Returns:

logger¤

logger = logging.getLogger(f'{self._client.logger.name}.{self.__class__.__name__}')

logs¤

logs: BuildLogs = BuildLogs(client=client)

The in-memory log buffer of Build: the most recent lines and the state of the buffer.

workspace¤

workspace: BuildWorkspace = BuildWorkspace(client=client)

Operations on the whole DataIntegration workspace: import, export, reload and status.

Comments