Skip to content

cmem_client.models.task¤

Task models for the DataIntegration task endpoint.

A task is what DataIntegration calls the items of a project: a dataset, a workflow, a transformation and so on. These models carry the full detail of a single one, as returned by TaskSearchRepository.get_task(), which is more than the search result the repositories list.

Classes:

  • TaskData – The data section of a task endpoint response.
  • TaskResponse – Response model for GET /workspace/projects/{project}/tasks/{task}.

TaskData¤

Bases: Model

The data section of a task endpoint response.

Attributes:

  • task_type (str | None) – Kind of task, e.g. Dataset or Workflow.
  • parameters (dict[str, Any]) – Parameters of the task, keyed by parameter name. Which ones are present depends on the plugin behind the task.

model_config¤

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

parameters¤

parameters: dict[str, Any] = Field(default_factory=dict)

task_type¤

task_type: str | None = Field(default=None, alias='taskType')

TaskResponse¤

Bases: Model

Response model for GET /workspace/projects/{project}/tasks/{task}.

Attributes:

  • id (str) – Identifier of the task, unique within its project.
  • label (str | None) – Human readable name of the task, if one is set.
  • data (TaskData) – Type and parameters of the task.

data¤

data: TaskData

id¤

id: str

label¤

label: str | None = None

model_config¤

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

Comments