Skip to content

omnipy.config.job

CLASS DESCRIPTION
JobConfig
LocalOutputStorageConfig
OutputStorageConfig
S3OutputStorageConfig

JobConfig

Bases: ConfigBase

ATTRIBUTE DESCRIPTION
output_storage

TYPE: IsOutputStorageConfig

Source code in src/omnipy/config/job.py
class JobConfig(ConfigBase):
    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

ATTRIBUTE DESCRIPTION
persist_data_dir_path

TYPE: str

Source code in src/omnipy/config/job.py
class LocalOutputStorageConfig(ConfigBase):
    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

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):
    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

persist_outputs class-attribute instance-attribute

protocol class-attribute instance-attribute

restore_outputs class-attribute instance-attribute

s3 class-attribute instance-attribute

S3OutputStorageConfig

Bases: ConfigBase

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):
    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 = ''