plexus.dashboard.api.models.task_stage module

class plexus.dashboard.api.models.task_stage.TaskStage(id: str, taskId: str, name: str, order: int, status: str, statusMessage: str | None = None, startedAt: datetime.datetime | None = None, completedAt: datetime.datetime | None = None, estimatedCompletionAt: datetime.datetime | None = None, processedItems: int | None = None, totalItems: int | None = None, client: plexus.dashboard.api.client._BaseAPIClient | None = None)

Bases: BaseModel

__init__(id: str, taskId: str, name: str, order: int, status: str, statusMessage: str | None = None, startedAt: datetime | None = None, completedAt: datetime | None = None, estimatedCompletionAt: datetime | None = None, processedItems: int | None = None, totalItems: int | None = None, client: _BaseAPIClient | None = None)

complete_processing() → None

Mark the stage as completed.

completedAt: datetime | None = None

classmethod create(client: _BaseAPIClient, taskId: str, name: str, order: int, status: str, statusMessage: str | None = None, **kwargs) → TaskStage

estimatedCompletionAt: datetime | None = None

fail_processing(error_message: str) → None

Mark the stage as failed with error information.

classmethod fields() → str

Return the GraphQL fields to query for this model

classmethod from_dict(data: Dict[str, Any], client: _BaseAPIClient) → TaskStage

Create an instance from a dictionary of data

classmethod get_by_id(id: str, client: _BaseAPIClient) → TaskStage

name: str

order: int

processedItems: int | None = None

start_processing() → None

Mark the stage as started and update its status.

startedAt: datetime | None = None

status: str

statusMessage: str | None = None

taskId: str

totalItems: int | None = None

update(**kwargs) → TaskStage

Update the task stage.