Skip to main content

models

Pydantic response models for the activity domain.

Module​

Global variables​

  • RunKind - The kinds of Prefect activity a Run can represent.

Classes​

ActivityStatus​

class ActivityStatus(**data: Any):

Live, currently-running patient-eligibility analyses.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Variables​

  • static model_config

EligibilityRunStatus​

class EligibilityRunStatus(**data: Any):

A currently-live patient-eligibility background run.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Variables​

  • static datasource_name : str
  • static model_config
  • static project_id : str

Run​

class Run(**data: Any):

One Prefect flow run.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Variables​

  • static datasource_name : str | None
  • static flow_run_id : str
  • static kind : Literal['eligibility', 'file_metadata', 'scan_metadata', 'file_metadata_refresh']
  • static model_config
  • static project_id : str | None
  • static task_hash : str | None

RunList​

class RunList(**data: Any):

A page of Runs.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Variables​

  • static items : list[Run]
  • static model_config
  • static total : int

RunState​

class RunState(*args, **kwds):

A Prefect flow run's state, as this API's own stable vocabulary.

Ancestors​

Variables​

  • static CANCELLED
  • static CANCELLING
  • static COMPLETED
  • static CRASHED
  • static FAILED
  • static PAUSED
  • static PENDING
  • static RUNNING
  • static SCHEDULED
  • static UNKNOWN