Skip to content

cmem_client.models.variable¤

Corporate Memory project variable models for data integration.

This module defines models for representing project variables within Corporate Memory DataIntegration projects. Variables can hold static values or Jinja2 template strings that reference other variables, and are used to parameterize datasets and tasks.

Classes:

  • Variable – A project variable in Corporate Memory DataIntegration.

Variable¤

Bases: ReadRepositoryItem

A project variable in Corporate Memory DataIntegration.

Attributes:

  • name (str) – Name of the variable, unique within its project. This is what a template refers to.
  • project_id (str) – ID of the project the variable belongs to.
  • value (str) – Resolved value of the variable. For a templated variable this is the rendered result, so it is read-only.
  • template (str) – Jinja2 template the value is rendered from. Empty for a variable which holds a static value.
  • description (str) – Description of the variable as maintained in the project.
  • is_sensitive (bool) – Whether the value is treated as a secret. Sensitive values are masked by the user interface.
  • scope (str) – Scope the variable is defined in, project for a project variable.

Functions:

  • get_id – Get the combined ID of the variable in the form project_id:name.

description¤

description: str = ''

get_id¤

get_id()

Get the combined ID of the variable in the form project_id:name.

is_sensitive¤

is_sensitive: bool = Field(alias='isSensitive', default=False)

model_config¤

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

name¤

name: str

project_id¤

project_id: str = Field(alias='project')

scope¤

scope: str = 'project'

template¤

template: str = ''

value¤

value: str = ''

Comments