roboto.upload_agent.files

Module Contents

UPLOAD_COMPLETE_FILENAME

roboto.upload_agent.files.UPLOAD_COMPLETE_FILENAME = '.roboto_upload_complete.json'#

UPLOAD_IN_PROGRESS_FILENAME

roboto.upload_agent.files.UPLOAD_IN_PROGRESS_FILENAME = '.roboto_upload_in_progress.json'#

UploadAgentConfig

class roboto.upload_agent.files.UploadAgentConfig(/, **data)#

Bases: pydantic.BaseModel

Upload agent configuration

Parameters

data Any

Attributes

UploadAgentConfig.default_org_id

default_org_id str | None = None #

The org ID to use when creating datasets via –merge-uploads, or other operations which may have an ambiguous org.

UploadAgentConfig.delete_empty_directories

delete_empty_directories bool = False #

If set to true, directories which are empty (or only contain a .roboto_upload_complete.json) after being uploaded will be automatically deleted. This is most useful if combined with delete_upload_files=True

UploadAgentConfig.delete_uploaded_files

delete_uploaded_files bool = False #

If set to true, will delete files from disk after they’ve been successfully uploaded to Roboto.

UploadAgentConfig.search_paths

search_paths list[pathlib.Path] #

Directories to recursively scan for files to upload.

UploadAgentConfig.upload_config_filename

upload_config_filename str = '.roboto_upload.json' #

The name of the upload marker file to look for.

UploadAgentConfig.version

version Literal['v1'] = 'v1' #

UploadCompleteFile

class roboto.upload_agent.files.UploadCompleteFile(/, **data)#

Bases: pydantic.BaseModel

Upload agent complete file

Parameters

data Any

Attributes

UploadCompleteFile.completed

completed datetime.datetime #

UploadCompleteFile.dataset_id

dataset_id str #

UploadCompleteFile.version

version Literal['v1'] = 'v1' #

UploadConfigFile

class roboto.upload_agent.files.UploadConfigFile(/, **data)#

Bases: pydantic.BaseModel

Upload agent config file

Parameters

data Any

Attributes

UploadConfigFile.dataset

dataset UploadConfigFileDatasetSection = None #

UploadConfigFile.upload

upload UploadConfigFileUploadSection = None #

UploadConfigFile.version

version Literal['v1'] = 'v1' #

UploadConfigFileDatasetSection

class roboto.upload_agent.files.UploadConfigFileDatasetSection(**data)#

Bases: roboto.domain.datasets.CreateDatasetRequest

Upload agent config file dataset section

Attributes

UploadConfigFileDatasetSection.add_to_collections

add_to_collections List[str] | None = None #

An optional list of collection IDs to attempt to add this dataset to.

UploadConfigFileDatasetSection.org_id

org_id str | None = None #

UploadConfigFileUploadSection

class roboto.upload_agent.files.UploadConfigFileUploadSection(/, **data)#

Bases: pydantic.BaseModel

Upload agent config file upload section

Parameters

data Any

Attributes

UploadConfigFileUploadSection.delete_uploaded_files

delete_uploaded_files bool | None = None #

UploadConfigFileUploadSection.exclude_patterns

exclude_patterns List[str] | None = None #

UploadConfigFileUploadSection.include_patterns

include_patterns List[str] | None = None #

UploadInProgressFile

class roboto.upload_agent.files.UploadInProgressFile(/, **data)#

Bases: pydantic.BaseModel

Upload agent in progress file

Parameters

data Any

Attributes

UploadInProgressFile.dataset_id

dataset_id str #

UploadInProgressFile.started

started datetime.datetime #

UploadInProgressFile.version

version Literal['v1'] = 'v1' #