server.web.schemas.workflow

Classes

WorkflowValidationRequest

Request model for workflow validation.

WorkflowValidationResponse

Response model for workflow validation.

WorkflowTasksResponse

Response model for workflow tasks.

WorkflowUserValidationResponse

Response model for workflow user validation.

WorkflowResetRequest

Request model for workflow reset.

WorkflowRunForResetResponse

Response model for workflow run reset validation.

WorkflowStatusResponse

Response model for workflow status.

WorkflowStatusVizResponse

Response model for workflow status visualization.

WorkflowOverviewRequest

Request model for workflow overview filters.

WorkflowOverviewItem

Individual workflow item in overview response.

WorkflowOverviewResponse

Response model for workflow overview.

TaskTableItem

Individual task item in task table response.

TaskTableResponse

Response model for task table visualization.

WorkflowDetailsItem

Workflow details item.

WorkflowDetailsResponse

Response model for workflow details.

Module Contents

class server.web.schemas.workflow.WorkflowValidationRequest[source]

Bases: pydantic.BaseModel

Request model for workflow validation.

task_ids: List[int][source]
class server.web.schemas.workflow.WorkflowValidationResponse[source]

Bases: pydantic.BaseModel

Response model for workflow validation.

validation: bool[source]
workflow_status: str | None = None[source]
class server.web.schemas.workflow.WorkflowTasksResponse[source]

Bases: pydantic.BaseModel

Response model for workflow tasks.

workflow_tasks: str[source]
class server.web.schemas.workflow.WorkflowUserValidationResponse[source]

Bases: pydantic.BaseModel

Response model for workflow user validation.

validation: bool[source]
class server.web.schemas.workflow.WorkflowResetRequest[source]

Bases: pydantic.BaseModel

Request model for workflow reset.

partial_reset: bool = False[source]
class server.web.schemas.workflow.WorkflowRunForResetResponse[source]

Bases: pydantic.BaseModel

Response model for workflow run reset validation.

workflow_run_id: int | None[source]
class server.web.schemas.workflow.WorkflowStatusResponse[source]

Bases: pydantic.BaseModel

Response model for workflow status.

workflows: str[source]
class server.web.schemas.workflow.WorkflowStatusVizResponse[source]

Bases: pydantic.BaseModel

Response model for workflow status visualization.

class server.web.schemas.workflow.WorkflowOverviewRequest[source]

Bases: pydantic.BaseModel

Request model for workflow overview filters.

user: str | None = None[source]
tool: str | None = None[source]
wf_name: str | None = None[source]
wf_args: str | None = None[source]
wf_attribute_value: str | None = None[source]
wf_attribute_key: str | None = None[source]
wf_id: str | None = None[source]
date_submitted: str | None = None[source]
date_submitted_end: str | None = None[source]
status: str | None = None[source]
class server.web.schemas.workflow.WorkflowOverviewItem[source]

Bases: pydantic.BaseModel

Individual workflow item in overview response.

wf_id: int[source]
wf_name: str[source]
wf_submitted_date: str[source]
wf_status_date: str[source]
wf_args: str | None[source]
wfr_count: int[source]
wf_status: str[source]
wf_tool: str[source]
PENDING: int = 0[source]
SCHEDULED: int = 0[source]
RUNNING: int = 0[source]
DONE: int = 0[source]
FATAL: int = 0[source]
class server.web.schemas.workflow.WorkflowOverviewResponse[source]

Bases: pydantic.BaseModel

Response model for workflow overview.

workflows: List[WorkflowOverviewItem][source]
class server.web.schemas.workflow.TaskTableItem[source]

Bases: pydantic.BaseModel

Individual task item in task table response.

task_id: int[source]
task_name: str[source]
task_status: str[source]
task_command: str[source]
task_num_attempts: int[source]
task_status_date: str[source]
task_max_attempts: int[source]
class server.web.schemas.workflow.TaskTableResponse[source]

Bases: pydantic.BaseModel

Response model for task table visualization.

tasks: List[TaskTableItem][source]
class server.web.schemas.workflow.WorkflowDetailsItem[source]

Bases: pydantic.BaseModel

Workflow details item.

wf_name: str[source]
wf_args: str | None[source]
wf_created_date: str[source]
wf_status_date: str[source]
tool_name: str[source]
wf_status: str[source]
wf_status_desc: str[source]
wfr_jobmon_version: str | None[source]
wfr_heartbeat_date: str | None[source]
wfr_user: str[source]
class server.web.schemas.workflow.WorkflowDetailsResponse[source]

Bases: pydantic.BaseModel

Response model for workflow details.