omnipy.config.job

Configuration models for persisted task and flow outputs.

CLASS	DESCRIPTION
JobConfig	Top-level job execution configuration.
LocalOutputStorageConfig	Filesystem-backed output storage settings.
OutputStorageConfig	Policy and backend settings for persisted outputs.
S3OutputStorageConfig	S3-compatible output storage settings.

JobConfig

Bases: ConfigBase

              flowchart BT
              omnipy.config.job.JobConfig[JobConfig]
              omnipy.config.ConfigBase[ConfigBase]
              omnipy.util.publisher.DataPublisher[DataPublisher]

                              omnipy.config.ConfigBase --> omnipy.config.job.JobConfig
                                omnipy.util.publisher.DataPublisher --> omnipy.config.ConfigBase
                                omnipy.util.pydantic.BaseModel --> omnipy.util.publisher.DataPublisher
                




              click omnipy.config.job.JobConfig href "" "omnipy.config.job.JobConfig"
              click omnipy.config.ConfigBase href "" "omnipy.config.ConfigBase"
              click omnipy.util.publisher.DataPublisher href "" "omnipy.util.publisher.DataPublisher"
            

Top-level job execution configuration.

ATTRIBUTE	DESCRIPTION
output_storage	TYPE: IsOutputStorageConfig

Source code in src/omnipy/config/job.py

class JobConfig(ConfigBase):
    """Top-level job execution configuration."""

    output_storage: IsOutputStorageConfig = pyd.Field(default_factory=OutputStorageConfig)

output_storage class-attribute instance-attribute

output_storage: IsOutputStorageConfig = pyd.Field(default_factory=OutputStorageConfig)

LocalOutputStorageConfig

Bases: ConfigBase

              flowchart BT
              omnipy.config.job.LocalOutputStorageConfig[LocalOutputStorageConfig]
              omnipy.config.ConfigBase[ConfigBase]
              omnipy.util.publisher.DataPublisher[DataPublisher]

                              omnipy.config.ConfigBase --> omnipy.config.job.LocalOutputStorageConfig
                                omnipy.util.publisher.DataPublisher --> omnipy.config.ConfigBase
                                omnipy.util.pydantic.BaseModel --> omnipy.util.publisher.DataPublisher
                




              click omnipy.config.job.LocalOutputStorageConfig href "" "omnipy.config.job.LocalOutputStorageConfig"
              click omnipy.config.ConfigBase href "" "omnipy.config.ConfigBase"
              click omnipy.util.publisher.DataPublisher href "" "omnipy.util.publisher.DataPublisher"
            

Filesystem-backed output storage settings.

Used by:

• Reference Code reference omnipy config  job  OutputStorageConfig  local

ATTRIBUTE	DESCRIPTION
persist_data_dir_path	TYPE: str

Source code in src/omnipy/config/job.py

class LocalOutputStorageConfig(ConfigBase):
    """Filesystem-backed output storage settings."""

    persist_data_dir_path: str = pyd.Field(default_factory=_get_persist_data_dir_path)

persist_data_dir_path class-attribute instance-attribute

persist_data_dir_path: str = pyd.Field(default_factory=_get_persist_data_dir_path)

OutputStorageConfig

Bases: ConfigBase

              flowchart BT
              omnipy.config.job.OutputStorageConfig[OutputStorageConfig]
              omnipy.config.ConfigBase[ConfigBase]
              omnipy.util.publisher.DataPublisher[DataPublisher]

                              omnipy.config.ConfigBase --> omnipy.config.job.OutputStorageConfig
                                omnipy.util.publisher.DataPublisher --> omnipy.config.ConfigBase
                                omnipy.util.pydantic.BaseModel --> omnipy.util.publisher.DataPublisher
                




              click omnipy.config.job.OutputStorageConfig href "" "omnipy.config.job.OutputStorageConfig"
              click omnipy.config.ConfigBase href "" "omnipy.config.ConfigBase"
              click omnipy.util.publisher.DataPublisher href "" "omnipy.util.publisher.DataPublisher"
            

Policy and backend settings for persisted outputs.

Used by:

• Reference Code reference omnipy config  job  JobConfig  output_storage

ATTRIBUTE	DESCRIPTION
local	TYPE: IsLocalOutputStorageConfig
persist_outputs	TYPE: ConfigPersistOutputsOptions.Literals
protocol	TYPE: ConfigOutputStorageProtocolOptions.Literals
restore_outputs	TYPE: ConfigRestoreOutputsOptions.Literals
s3	TYPE: IsS3OutputStorageConfig

Source code in src/omnipy/config/job.py

class OutputStorageConfig(ConfigBase):
    """Policy and backend settings for persisted outputs."""

    persist_outputs: ConfigPersistOutputsOptions.Literals = \
        ConfigPersistOutputsOptions.ENABLE_FLOW_AND_TASK_OUTPUTS
    restore_outputs: ConfigRestoreOutputsOptions.Literals = \
        ConfigRestoreOutputsOptions.DISABLED
    protocol: ConfigOutputStorageProtocolOptions.Literals = ConfigOutputStorageProtocolOptions.LOCAL
    local: IsLocalOutputStorageConfig = pyd.Field(default_factory=LocalOutputStorageConfig)
    s3: IsS3OutputStorageConfig = pyd.Field(default_factory=S3OutputStorageConfig)

local class-attribute instance-attribute

local: IsLocalOutputStorageConfig = pyd.Field(default_factory=LocalOutputStorageConfig)

persist_outputs class-attribute instance-attribute

persist_outputs: ConfigPersistOutputsOptions.Literals = (
    ConfigPersistOutputsOptions.ENABLE_FLOW_AND_TASK_OUTPUTS
)

protocol class-attribute instance-attribute

protocol: ConfigOutputStorageProtocolOptions.Literals = ConfigOutputStorageProtocolOptions.LOCAL

restore_outputs class-attribute instance-attribute

restore_outputs: ConfigRestoreOutputsOptions.Literals = ConfigRestoreOutputsOptions.DISABLED

s3 class-attribute instance-attribute

s3: IsS3OutputStorageConfig = pyd.Field(default_factory=S3OutputStorageConfig)

S3OutputStorageConfig

Bases: ConfigBase

              flowchart BT
              omnipy.config.job.S3OutputStorageConfig[S3OutputStorageConfig]
              omnipy.config.ConfigBase[ConfigBase]
              omnipy.util.publisher.DataPublisher[DataPublisher]

                              omnipy.config.ConfigBase --> omnipy.config.job.S3OutputStorageConfig
                                omnipy.util.publisher.DataPublisher --> omnipy.config.ConfigBase
                                omnipy.util.pydantic.BaseModel --> omnipy.util.publisher.DataPublisher
                




              click omnipy.config.job.S3OutputStorageConfig href "" "omnipy.config.job.S3OutputStorageConfig"
              click omnipy.config.ConfigBase href "" "omnipy.config.ConfigBase"
              click omnipy.util.publisher.DataPublisher href "" "omnipy.util.publisher.DataPublisher"
            

S3-compatible output storage settings.

Used by:

• Reference Code reference omnipy config  job  OutputStorageConfig  s3

ATTRIBUTE	DESCRIPTION
access_key	TYPE: str
bucket_name	TYPE: str
endpoint_url	TYPE: str
persist_data_dir_path	TYPE: str
secret_key	TYPE: str

Source code in src/omnipy/config/job.py

class S3OutputStorageConfig(ConfigBase):
    """S3-compatible output storage settings."""

    persist_data_dir_path: str = os.path.join('omnipy', 'outputs')
    endpoint_url: str = ''
    bucket_name: str = ''
    access_key: str = ''
    secret_key: str = ''

access_key class-attribute instance-attribute

access_key: str = ''

bucket_name class-attribute instance-attribute

bucket_name: str = ''

endpoint_url class-attribute instance-attribute

endpoint_url: str = ''

persist_data_dir_path class-attribute instance-attribute

persist_data_dir_path: str = os.path.join('omnipy', 'outputs')

secret_key class-attribute instance-attribute

secret_key: str = ''