Skip to content

omnipy.shared.enums.job

CLASS DESCRIPTION
ConfigOutputStorageProtocolOptions
ConfigPersistOutputsOptions
ConfigRestoreOutputsOptions
EngineChoice
OutputStorageProtocolOptions
PersistOutputsOptions
RestoreOutputsOptions
RunState
RunStateLogMessages

ConfigOutputStorageProtocolOptions

Bases: LiteralEnum[str]

ATTRIBUTE DESCRIPTION
LOCAL

TYPE: Literal['local']

Literals

S3

TYPE: Literal['s3']

Source code in src/omnipy/shared/enums/job.py
class ConfigOutputStorageProtocolOptions(LiteralEnum[str]):
    Literals = Literal['local', 's3']

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

LOCAL class-attribute instance-attribute

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

Literals class-attribute instance-attribute

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

S3 class-attribute instance-attribute

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

ConfigPersistOutputsOptions

Bases: LiteralEnum[str]

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
class ConfigPersistOutputsOptions(LiteralEnum[str]):
    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'

ENABLE_FLOW_OUTPUTS class-attribute instance-attribute

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

Literals class-attribute instance-attribute

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

ConfigRestoreOutputsOptions

Bases: LiteralEnum[str]

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
class ConfigRestoreOutputsOptions(LiteralEnum[str]):
    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'

Literals class-attribute instance-attribute

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

EngineChoice

Bases: LiteralEnum[str]

ATTRIBUTE DESCRIPTION
LOCAL

TYPE: Literal['local']

Literals

PREFECT

TYPE: Literal['prefect']

Source code in src/omnipy/shared/enums/job.py
class EngineChoice(LiteralEnum[str]):
    Literals = Literal['local', 'prefect']

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

LOCAL class-attribute instance-attribute

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

Literals class-attribute instance-attribute

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

PREFECT class-attribute instance-attribute

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

OutputStorageProtocolOptions

Bases: LiteralEnum[str]

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
class OutputStorageProtocolOptions(LiteralEnum[str]):
    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']

S3 class-attribute instance-attribute

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

PersistOutputsOptions

Bases: LiteralEnum[str]

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
class PersistOutputsOptions(LiteralEnum[str]):
    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'

Literals class-attribute instance-attribute

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

RestoreOutputsOptions

Bases: LiteralEnum[str]

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
class RestoreOutputsOptions(LiteralEnum[str]):
    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'

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']

RunState

Bases: LiteralEnum[int]

ATTRIBUTE DESCRIPTION
FINISHED

TYPE: Literal[3]

INITIALIZED

TYPE: Literal[1]

Literals

RUNNING

TYPE: Literal[2]

Source code in src/omnipy/shared/enums/job.py
class RunState(LiteralEnum[int]):
    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]

RUNNING class-attribute instance-attribute

RUNNING: Literal[2] = 2

RunStateLogMessages

Bases: LiteralEnum[str]

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
class RunStateLogMessages(LiteralEnum[str]):
    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 "{}"...'