Skip to content

omnipy.shared.enums.job

Job-related literal enums for execution, persistence, and restoration settings.

CLASS DESCRIPTION
ConfigOutputStorageProtocolOptions

Configuration defaults for output storage protocols.
ConfigPersistOutputsOptions

Configuration defaults for persisting flow and task outputs.
ConfigRestoreOutputsOptions

Configuration defaults for restoring persisted outputs.
EngineChoice

Execution engine enum values for running jobs.
FlowJobType

Literal enum values for supported flow job categories.
JobType

Combined literal enum values for all supported Omnipy job categories.
OutputStorageProtocolOptions

Per-run options for which output storage protocol to use.
PersistOutputsOptions

Per-run options for whether to persist outputs.
RestoreOutputsOptions

Per-run options for whether to restore persisted outputs.
RunState

Lifecycle state enum values for a running job.
RunStateLogMessages

Default log message templates associated with each run state.
TaskJobType

Literal enum values for task job categories.

ConfigOutputStorageProtocolOptions

Bases: LiteralEnum[str]


              flowchart BT
              omnipy.shared.enums.job.ConfigOutputStorageProtocolOptions[ConfigOutputStorageProtocolOptions]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.job.ConfigOutputStorageProtocolOptions
                


              click omnipy.shared.enums.job.ConfigOutputStorageProtocolOptions href "" "omnipy.shared.enums.job.ConfigOutputStorageProtocolOptions"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

Configuration defaults for output storage protocols.

Returned by: Used by:
ATTRIBUTE DESCRIPTION
LOCAL

TYPE: Literal['local']

Literals

S3

TYPE: Literal['s3']

Source code in src/omnipy/shared/enums/job.py 
58
59
60
61
62
63
64
class ConfigOutputStorageProtocolOptions(LiteralEnum[str]):
    """Configuration defaults for output storage protocols."""

    Literals = Literal['local', 's3']

    LOCAL: Literal['local'] = 'local'
    S3: Literal['s3'] = 's3'

LOCAL class-attribute instance-attribute 

LOCAL: Literal['local'] = 'local'
Used by:

Literals class-attribute instance-attribute 

Literals = Literal['local', 's3']
Returned by:

S3 class-attribute instance-attribute 

S3: Literal['s3'] = 's3'

ConfigPersistOutputsOptions

Bases: LiteralEnum[str]


              flowchart BT
              omnipy.shared.enums.job.ConfigPersistOutputsOptions[ConfigPersistOutputsOptions]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.job.ConfigPersistOutputsOptions
                


              click omnipy.shared.enums.job.ConfigPersistOutputsOptions href "" "omnipy.shared.enums.job.ConfigPersistOutputsOptions"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

Configuration defaults for persisting flow and task outputs.

Returned by: Used by:
ATTRIBUTE DESCRIPTION
DISABLED

TYPE: Literal['disabled']

ENABLE_FLOW_AND_TASK_OUTPUTS

TYPE: Literal['all']

ENABLE_FLOW_OUTPUTS

TYPE: Literal['flow']

Literals

Source code in src/omnipy/shared/enums/job.py 
39
40
41
42
43
44
45
46
class ConfigPersistOutputsOptions(LiteralEnum[str]):
    """Configuration defaults for persisting flow and task outputs."""

    Literals = Literal['disabled', 'flow', 'all']

    DISABLED: Literal['disabled'] = 'disabled'
    ENABLE_FLOW_OUTPUTS: Literal['flow'] = 'flow'
    ENABLE_FLOW_AND_TASK_OUTPUTS: Literal['all'] = 'all'

DISABLED class-attribute instance-attribute 

DISABLED: Literal['disabled'] = 'disabled'

ENABLE_FLOW_AND_TASK_OUTPUTS class-attribute instance-attribute 

ENABLE_FLOW_AND_TASK_OUTPUTS: Literal['all'] = 'all'
Used by:

ENABLE_FLOW_OUTPUTS class-attribute instance-attribute 

ENABLE_FLOW_OUTPUTS: Literal['flow'] = 'flow'

Literals class-attribute instance-attribute 

Literals = Literal['disabled', 'flow', 'all']
Returned by:

ConfigRestoreOutputsOptions

Bases: LiteralEnum[str]


              flowchart BT
              omnipy.shared.enums.job.ConfigRestoreOutputsOptions[ConfigRestoreOutputsOptions]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.job.ConfigRestoreOutputsOptions
                


              click omnipy.shared.enums.job.ConfigRestoreOutputsOptions href "" "omnipy.shared.enums.job.ConfigRestoreOutputsOptions"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

Configuration defaults for restoring persisted outputs.

Returned by: Used by:
ATTRIBUTE DESCRIPTION
AUTO_ENABLE_IGNORE_PARAMS

TYPE: Literal['auto_ignore_params']

DISABLED

TYPE: Literal['disabled']

Literals

Source code in src/omnipy/shared/enums/job.py 
49
50
51
52
53
54
55
class ConfigRestoreOutputsOptions(LiteralEnum[str]):
    """Configuration defaults for restoring persisted outputs."""

    Literals = Literal['disabled', 'auto_ignore_params']

    DISABLED: Literal['disabled'] = 'disabled'
    AUTO_ENABLE_IGNORE_PARAMS: Literal['auto_ignore_params'] = 'auto_ignore_params'

AUTO_ENABLE_IGNORE_PARAMS class-attribute instance-attribute 

AUTO_ENABLE_IGNORE_PARAMS: Literal['auto_ignore_params'] = 'auto_ignore_params'

DISABLED class-attribute instance-attribute 

DISABLED: Literal['disabled'] = 'disabled'
Used by:

Literals class-attribute instance-attribute 

Literals = Literal['disabled', 'auto_ignore_params']
Returned by:

EngineChoice

Bases: LiteralEnum[str]


              flowchart BT
              omnipy.shared.enums.job.EngineChoice[EngineChoice]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.job.EngineChoice
                


              click omnipy.shared.enums.job.EngineChoice href "" "omnipy.shared.enums.job.EngineChoice"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

Execution engine enum values for running jobs.

Returned by: Used by:
ATTRIBUTE DESCRIPTION
LOCAL

TYPE: Literal['local']

Literals

PREFECT

TYPE: Literal['prefect']

Source code in src/omnipy/shared/enums/job.py 
67
68
69
70
71
72
73
class EngineChoice(LiteralEnum[str]):
    """Execution engine enum values for running jobs."""

    Literals = Literal['local', 'prefect']

    LOCAL: Literal['local'] = 'local'
    PREFECT: Literal['prefect'] = 'prefect'

LOCAL class-attribute instance-attribute 

LOCAL: Literal['local'] = 'local'
Used by:

Literals class-attribute instance-attribute 

Literals = Literal['local', 'prefect']
Returned by:

PREFECT class-attribute instance-attribute 

PREFECT: Literal['prefect'] = 'prefect'

FlowJobType

Bases: LiteralEnum[str]


              flowchart BT
              omnipy.shared.enums.job.FlowJobType[FlowJobType]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.job.FlowJobType
                


              click omnipy.shared.enums.job.FlowJobType href "" "omnipy.shared.enums.job.FlowJobType"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

Literal enum values for supported flow job categories.

Subclassed by: Used by:
ATTRIBUTE DESCRIPTION
DAG_FLOW

TYPE: Literal['dag_flow']

FUNC_FLOW

TYPE: Literal['func_flow']

LINEAR_FLOW

TYPE: Literal['linear_flow']

Literals

Source code in src/omnipy/shared/enums/job.py 
84
85
86
87
88
89
90
91
class FlowJobType(LiteralEnum[str]):
    """Literal enum values for supported flow job categories."""

    Literals = Literal['linear_flow', 'dag_flow', 'func_flow']

    LINEAR_FLOW: Literal['linear_flow'] = 'linear_flow'
    DAG_FLOW: Literal['dag_flow'] = 'dag_flow'
    FUNC_FLOW: Literal['func_flow'] = 'func_flow'

DAG_FLOW class-attribute instance-attribute 

DAG_FLOW: Literal['dag_flow'] = 'dag_flow'
Used by:

FUNC_FLOW class-attribute instance-attribute 

FUNC_FLOW: Literal['func_flow'] = 'func_flow'
Used by:

LINEAR_FLOW class-attribute instance-attribute 

LINEAR_FLOW: Literal['linear_flow'] = 'linear_flow'
Used by:

Literals class-attribute instance-attribute 

Literals = Literal['linear_flow', 'dag_flow', 'func_flow']
Used by:

JobType

Bases: TaskJobType, FlowJobType


              flowchart BT
              omnipy.shared.enums.job.JobType[JobType]
              omnipy.shared.enums.job.TaskJobType[TaskJobType]
              omnipy.shared.enums.job.FlowJobType[FlowJobType]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.shared.enums.job.TaskJobType --> omnipy.shared.enums.job.JobType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.job.TaskJobType
                

                omnipy.shared.enums.job.FlowJobType --> omnipy.shared.enums.job.JobType
                                omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.job.FlowJobType
                



              click omnipy.shared.enums.job.JobType href "" "omnipy.shared.enums.job.JobType"
              click omnipy.shared.enums.job.TaskJobType href "" "omnipy.shared.enums.job.TaskJobType"
              click omnipy.shared.enums.job.FlowJobType href "" "omnipy.shared.enums.job.FlowJobType"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

Combined literal enum values for all supported Omnipy job categories.

Returned by: Used by:
ATTRIBUTE DESCRIPTION
Literals

Source code in src/omnipy/shared/enums/job.py 
94
95
96
97
class JobType(TaskJobType, FlowJobType):
    """Combined literal enum values for all supported Omnipy job categories."""

    Literals = Literal[TaskJobType.Literals, FlowJobType.Literals]

Literals class-attribute instance-attribute 

Literals = Literal[TaskJobType.Literals, FlowJobType.Literals]
Returned by: Used by:

OutputStorageProtocolOptions

Bases: LiteralEnum[str]


              flowchart BT
              omnipy.shared.enums.job.OutputStorageProtocolOptions[OutputStorageProtocolOptions]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.job.OutputStorageProtocolOptions
                


              click omnipy.shared.enums.job.OutputStorageProtocolOptions href "" "omnipy.shared.enums.job.OutputStorageProtocolOptions"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

Per-run options for which output storage protocol to use.

Returned by: Used by:
ATTRIBUTE DESCRIPTION
FOLLOW_CONFIG

TYPE: Literal['config']

LOCAL

TYPE: Literal['local']

Literals

S3

TYPE: Literal['s3']

Source code in src/omnipy/shared/enums/job.py 
29
30
31
32
33
34
35
36
class OutputStorageProtocolOptions(LiteralEnum[str]):
    """Per-run options for which output storage protocol to use."""

    Literals = Literal['local', 's3', 'config']

    LOCAL: Literal['local'] = 'local'
    S3: Literal['s3'] = 's3'
    FOLLOW_CONFIG: Literal['config'] = 'config'

FOLLOW_CONFIG class-attribute instance-attribute 

FOLLOW_CONFIG: Literal['config'] = 'config'

LOCAL class-attribute instance-attribute 

LOCAL: Literal['local'] = 'local'

Literals class-attribute instance-attribute 

Literals = Literal['local', 's3', 'config']
Returned by:

S3 class-attribute instance-attribute 

S3: Literal['s3'] = 's3'

PersistOutputsOptions

Bases: LiteralEnum[str]


              flowchart BT
              omnipy.shared.enums.job.PersistOutputsOptions[PersistOutputsOptions]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.job.PersistOutputsOptions
                


              click omnipy.shared.enums.job.PersistOutputsOptions href "" "omnipy.shared.enums.job.PersistOutputsOptions"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

Per-run options for whether to persist outputs.

Returned by: Used by:
ATTRIBUTE DESCRIPTION
DISABLED

TYPE: Literal['disabled']

ENABLED

TYPE: Literal['enabled']

FOLLOW_CONFIG

TYPE: Literal['config']

Literals

Source code in src/omnipy/shared/enums/job.py 
 8
 9
10
11
12
13
14
15
class PersistOutputsOptions(LiteralEnum[str]):
    """Per-run options for whether to persist outputs."""

    Literals = Literal['disabled', 'config', 'enabled']

    DISABLED: Literal['disabled'] = 'disabled'
    FOLLOW_CONFIG: Literal['config'] = 'config'
    ENABLED: Literal['enabled'] = 'enabled'

DISABLED class-attribute instance-attribute 

DISABLED: Literal['disabled'] = 'disabled'

ENABLED class-attribute instance-attribute 

ENABLED: Literal['enabled'] = 'enabled'

FOLLOW_CONFIG class-attribute instance-attribute 

FOLLOW_CONFIG: Literal['config'] = 'config'
Used by:

Literals class-attribute instance-attribute 

Literals = Literal['disabled', 'config', 'enabled']
Returned by: Used by:

RestoreOutputsOptions

Bases: LiteralEnum[str]


              flowchart BT
              omnipy.shared.enums.job.RestoreOutputsOptions[RestoreOutputsOptions]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.job.RestoreOutputsOptions
                


              click omnipy.shared.enums.job.RestoreOutputsOptions href "" "omnipy.shared.enums.job.RestoreOutputsOptions"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

Per-run options for whether to restore persisted outputs.

Returned by: Used by:
ATTRIBUTE DESCRIPTION
AUTO_ENABLE_IGNORE_PARAMS

TYPE: Literal['auto_ignore_params']

DISABLED

TYPE: Literal['disabled']

FOLLOW_CONFIG

TYPE: Literal['config']

FORCE_ENABLE_IGNORE_PARAMS

TYPE: Literal['force_ignore_params']

Literals

Source code in src/omnipy/shared/enums/job.py 
18
19
20
21
22
23
24
25
26
class RestoreOutputsOptions(LiteralEnum[str]):
    """Per-run options for whether to restore persisted outputs."""

    Literals = Literal['disabled', 'config', 'auto_ignore_params', 'force_ignore_params']

    DISABLED: Literal['disabled'] = 'disabled'
    FOLLOW_CONFIG: Literal['config'] = 'config'
    AUTO_ENABLE_IGNORE_PARAMS: Literal['auto_ignore_params'] = 'auto_ignore_params'
    FORCE_ENABLE_IGNORE_PARAMS: Literal['force_ignore_params'] = 'force_ignore_params'

AUTO_ENABLE_IGNORE_PARAMS class-attribute instance-attribute 

AUTO_ENABLE_IGNORE_PARAMS: Literal['auto_ignore_params'] = 'auto_ignore_params'

DISABLED class-attribute instance-attribute 

DISABLED: Literal['disabled'] = 'disabled'

FOLLOW_CONFIG class-attribute instance-attribute 

FOLLOW_CONFIG: Literal['config'] = 'config'
Used by:

FORCE_ENABLE_IGNORE_PARAMS class-attribute instance-attribute 

FORCE_ENABLE_IGNORE_PARAMS: Literal['force_ignore_params'] = 'force_ignore_params'

Literals class-attribute instance-attribute 

Literals = Literal['disabled', 'config', 'auto_ignore_params', 'force_ignore_params']
Returned by: Used by:

RunState

Bases: LiteralEnum[int]


              flowchart BT
              omnipy.shared.enums.job.RunState[RunState]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.job.RunState
                


              click omnipy.shared.enums.job.RunState href "" "omnipy.shared.enums.job.RunState"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

Lifecycle state enum values for a running job.

Returned by: Used by:
ATTRIBUTE DESCRIPTION
FINISHED

TYPE: Literal[3]

INITIALIZED

TYPE: Literal[1]

Literals

RUNNING

TYPE: Literal[2]

Source code in src/omnipy/shared/enums/job.py 
100
101
102
103
104
105
106
107
class RunState(LiteralEnum[int]):
    """Lifecycle state enum values for a running job."""

    Literals = Literal[1, 2, 3]

    INITIALIZED: Literal[1] = 1
    RUNNING: Literal[2] = 2
    FINISHED: Literal[3] = 3

FINISHED class-attribute instance-attribute 

FINISHED: Literal[3] = 3

INITIALIZED class-attribute instance-attribute 

INITIALIZED: Literal[1] = 1

Literals class-attribute instance-attribute 

Literals = Literal[1, 2, 3]
Returned by: Used by:

RUNNING class-attribute instance-attribute 

RUNNING: Literal[2] = 2

RunStateLogMessages

Bases: LiteralEnum[str]


              flowchart BT
              omnipy.shared.enums.job.RunStateLogMessages[RunStateLogMessages]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.job.RunStateLogMessages
                


              click omnipy.shared.enums.job.RunStateLogMessages href "" "omnipy.shared.enums.job.RunStateLogMessages"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

Default log message templates associated with each run state.

ATTRIBUTE DESCRIPTION
FINISHED

TYPE: Literal['Finished running "{}"!']

INITIALIZED

TYPE: Literal['Initialized "{}"']

Literals

RUNNING

TYPE: Literal['Started running "{}"...']

Source code in src/omnipy/shared/enums/job.py 
110
111
112
113
114
115
116
117
class RunStateLogMessages(LiteralEnum[str]):
    """Default log message templates associated with each run state."""

    Literals = Literal['Initialized "{}"', 'Started running "{}"...', 'Finished running "{}"!']

    INITIALIZED: Literal['Initialized "{}"'] = 'Initialized "{}"'
    RUNNING: Literal['Started running "{}"...'] = 'Started running "{}"...'
    FINISHED: Literal['Finished running "{}"!'] = 'Finished running "{}"!'

FINISHED class-attribute instance-attribute 

FINISHED: Literal['Finished running "{}"!'] = 'Finished running "{}"!'

INITIALIZED class-attribute instance-attribute 

INITIALIZED: Literal['Initialized "{}"'] = 'Initialized "{}"'

Literals class-attribute instance-attribute 

Literals = Literal['Initialized "{}"', 'Started running "{}"...', 'Finished running "{}"!']

RUNNING class-attribute instance-attribute 

RUNNING: Literal['Started running "{}"...'] = 'Started running "{}"...'

TaskJobType

Bases: LiteralEnum[str]


              flowchart BT
              omnipy.shared.enums.job.TaskJobType[TaskJobType]
              omnipy.util.literal_enum.LiteralEnum[LiteralEnum]

                              omnipy.util.literal_enum.LiteralEnum --> omnipy.shared.enums.job.TaskJobType
                


              click omnipy.shared.enums.job.TaskJobType href "" "omnipy.shared.enums.job.TaskJobType"
              click omnipy.util.literal_enum.LiteralEnum href "" "omnipy.util.literal_enum.LiteralEnum"

Literal enum values for task job categories.

Subclassed by: Used by:
ATTRIBUTE DESCRIPTION
Literals

TASK

TYPE: Literal['task']

Source code in src/omnipy/shared/enums/job.py 
76
77
78
79
80
81
class TaskJobType(LiteralEnum[str]):
    """Literal enum values for task job categories."""

    Literals = Literal['task']

    TASK: Literal['task'] = 'task'

Literals class-attribute instance-attribute 

Literals = Literal['task']
Used by:

TASK class-attribute instance-attribute 

TASK: Literal['task'] = 'task'
Used by: