queenbee.job.job module¶

class queenbee.job.job.Job(*, type: ConstrainedStrValue = 'Job', annotations: Dict[str, Any] = None, api_version: ConstrainedStrValue = 'v1beta1', source: str, arguments: List[List[JobArgument | JobPathArgument]] = None, name: str = None, description: str = None, labels: Dict[str, str] = None)[source]¶

Bases: BaseModel

Queenbee Job.

A Job is an object to submit a list of arguments to execute a Queenbee recipe.

api_version: ConstrainedStrValue¶

arguments: List[List[JobArgument | JobPathArgument]]¶

classmethod check_duplicate_names(v)[source]¶

description: str¶

labels: Dict[str, str]¶

name: str¶

populate_default_arguments(inputs: List[DAGGenericInput | DAGStringInput | DAGIntegerInput | DAGNumberInput | DAGBooleanInput | DAGFolderInput | DAGFileInput | DAGPathInput | DAGArrayInput | DAGJSONObjectInput])[source]¶

source: str¶

type: ConstrainedStrValue¶

validate_arguments(inputs: List[DAGGenericInput | DAGStringInput | DAGIntegerInput | DAGNumberInput | DAGBooleanInput | DAGFolderInput | DAGFileInput | DAGPathInput | DAGArrayInput | DAGJSONObjectInput])[source]¶

class queenbee.job.job.JobStatus(*, type: ConstrainedStrValue = 'JobStatus', annotations: Dict[str, Any] = None, api_version: ConstrainedStrValue = 'v1beta1', id: str, status: JobStatusEnum = JobStatusEnum.unknown, message: str = None, started_at: datetime, finished_at: datetime = None, source: str = None, runs_pending: int = 0, runs_running: int = 0, runs_completed: int = 0, runs_failed: int = 0, runs_cancelled: int = 0)[source]¶

Bases: BaseModel

Parametric Job Status.

api_version: ConstrainedStrValue¶

finished_at: datetime¶

id: str¶

message: str¶

runs_cancelled: int¶

runs_completed: int¶

runs_failed: int¶

runs_pending: int¶

runs_running: int¶

source: str¶

started_at: datetime¶

status: JobStatusEnum¶

type: ConstrainedStrValue¶

class queenbee.job.job.JobStatusEnum(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Enumaration of allowable status strings

cancelled = 'Cancelled'¶

completed = 'Completed'¶

created = 'Created'¶

failed = 'Failed'¶

pre_processing = 'Pre-Processing'¶

running = 'Running'¶

unknown = 'Unknown'¶