Module omnipy.api.enums

Overview

View Source

from enum import Enum, IntEnum

class PersistOutputsOptions(str, Enum):

    """"""

    DISABLED = 'disabled'

    FOLLOW_CONFIG = 'config'

    ENABLED = 'enabled'

class RestoreOutputsOptions(str, Enum):

    """"""

    DISABLED = 'disabled'

    FOLLOW_CONFIG = 'config'

    AUTO_ENABLE_IGNORE_PARAMS = 'auto_ignore_params'

    FORCE_ENABLE_IGNORE_PARAMS = 'force_ignore_params'

class OutputStorageProtocolOptions(str, Enum):

    """"""

    LOCAL = 'local'

    S3 = 's3'

    FOLLOW_CONFIG = 'config'

class ConfigPersistOutputsOptions(str, Enum):

    """"""

    DISABLED = 'disabled'

    ENABLE_FLOW_OUTPUTS = 'flow'

    ENABLE_FLOW_AND_TASK_OUTPUTS = 'all'

class ConfigRestoreOutputsOptions(str, Enum):

    """"""

    DISABLED = 'disabled'

    AUTO_ENABLE_IGNORE_PARAMS = 'auto_ignore_params'

class ConfigOutputStorageProtocolOptions(str, Enum):

    """"""

    LOCAL = 'local'

    S3 = 's3'

class EngineChoice(str, Enum):

    """"""

    LOCAL = 'local'

    PREFECT = 'prefect'

class RunState(IntEnum):

    """"""

    INITIALIZED = 1

    RUNNING = 2

    FINISHED = 3

# TODO: Add 'apply' state

# TODO: Add 'failed' state and error management

# TODO: Consider the need for a 'waiting' state

class RunStateLogMessages(str, Enum):

    """"""

    INITIALIZED = 'Initialized "{}"'

    RUNNING = 'Started running "{}"...'

    FINISHED = 'Finished running "{}"!'

Classes

ConfigOutputStorageProtocolOptions

class ConfigOutputStorageProtocolOptions(
    /,
    *args,
    **kwargs
)

View Source

class ConfigOutputStorageProtocolOptions(str, Enum):

    """"""

    LOCAL = 'local'

    S3 = 's3'

---

Class variables

LOCAL

S3

ConfigPersistOutputsOptions

class ConfigPersistOutputsOptions(
    /,
    *args,
    **kwargs
)

View Source

class ConfigPersistOutputsOptions(str, Enum):

    """"""

    DISABLED = 'disabled'

    ENABLE_FLOW_OUTPUTS = 'flow'

    ENABLE_FLOW_AND_TASK_OUTPUTS = 'all'

---

Class variables

DISABLED

ENABLE_FLOW_AND_TASK_OUTPUTS

ENABLE_FLOW_OUTPUTS

ConfigRestoreOutputsOptions

class ConfigRestoreOutputsOptions(
    /,
    *args,
    **kwargs
)

View Source

class ConfigRestoreOutputsOptions(str, Enum):

    """"""

    DISABLED = 'disabled'

    AUTO_ENABLE_IGNORE_PARAMS = 'auto_ignore_params'

---

Class variables

AUTO_ENABLE_IGNORE_PARAMS

DISABLED

EngineChoice

class EngineChoice(
    /,
    *args,
    **kwargs
)

View Source

class EngineChoice(str, Enum):

    """"""

    LOCAL = 'local'

    PREFECT = 'prefect'

---

Class variables

LOCAL

PREFECT

OutputStorageProtocolOptions

class OutputStorageProtocolOptions(
    /,
    *args,
    **kwargs
)

View Source

class OutputStorageProtocolOptions(str, Enum):

    """"""

    LOCAL = 'local'

    S3 = 's3'

    FOLLOW_CONFIG = 'config'

---

Class variables

FOLLOW_CONFIG

LOCAL

S3

PersistOutputsOptions

class PersistOutputsOptions(
    /,
    *args,
    **kwargs
)

View Source

class PersistOutputsOptions(str, Enum):

    """"""

    DISABLED = 'disabled'

    FOLLOW_CONFIG = 'config'

    ENABLED = 'enabled'

---

Class variables

DISABLED

ENABLED

FOLLOW_CONFIG

RestoreOutputsOptions

class RestoreOutputsOptions(
    /,
    *args,
    **kwargs
)

View Source

class RestoreOutputsOptions(str, Enum):

    """"""

    DISABLED = 'disabled'

    FOLLOW_CONFIG = 'config'

    AUTO_ENABLE_IGNORE_PARAMS = 'auto_ignore_params'

    FORCE_ENABLE_IGNORE_PARAMS = 'force_ignore_params'

---

Class variables

AUTO_ENABLE_IGNORE_PARAMS

DISABLED

FOLLOW_CONFIG

FORCE_ENABLE_IGNORE_PARAMS

RunState

class RunState(
    /,
    *args,
    **kwargs
)

View Source

class RunState(IntEnum):

    """"""

    INITIALIZED = 1

    RUNNING = 2

    FINISHED = 3

---

Class variables

FINISHED

INITIALIZED

RUNNING

RunStateLogMessages

class RunStateLogMessages(
    /,
    *args,
    **kwargs
)

View Source

class RunStateLogMessages(str, Enum):

    """"""

    INITIALIZED = 'Initialized "{}"'

    RUNNING = 'Started running "{}"...'

    FINISHED = 'Finished running "{}"!'

---

Class variables

FINISHED

INITIALIZED

RUNNING