roboto.domain.files.operations#

Module Contents#

class roboto.domain.files.operations.AbortTransactionsRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload for aborting file upload transactions.

Used to cancel ongoing file upload transactions, typically when uploads fail or are no longer needed. This cleans up any reserved resources and marks associated files as no longer pending.

Parameters:: data (Any)

transaction_ids: list[str]#: List of transaction IDs to abort.

class roboto.domain.files.operations.DeleteFileRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload for deleting a file from the platform.

This request is used internally by the platform to delete files and their associated data. The file is identified by its storage URI.

Parameters:: data (Any)

uri: str#

//bucket/path/to/file.bag’).

Type:: Storage URI of the file to delete (e.g., ‘s3

class roboto.domain.files.operations.DirectoryContentsPage(/, **data)#

Bases: pydantic.BaseModel

Response containing the contents of a dataset directory page.

Represents a paginated view of files and subdirectories within a dataset directory. Used when browsing dataset contents hierarchically.

Parameters:: data (Any)

directories: collections.abc.Sequence[roboto.domain.files.record.DirectoryRecord]#: Subdirectories contained in this directory page.

files: collections.abc.Sequence[roboto.domain.files.record.FileRecord]#: Files contained in this directory page.

next_token: str | None = None#: Token for retrieving the next page of results, if any.

class roboto.domain.files.operations.FileRecordRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload for upserting a file record.

Used to create or update file metadata records in the platform. This is typically used during file import or metadata update operations.

Parameters:: data (Any)

file_id: str#: Unique identifier for the file.

metadata: dict[str, Any] = None#: Key-value metadata pairs to associate with the file.

tags: list[str] = None#: List of tags to associate with the file for discovery and organization.

class roboto.domain.files.operations.ImportFileRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload for importing an existing file into a dataset.

Used to register files that already exist in storage (such as customer S3 buckets) with the Roboto platform. The file content remains in its original location while metadata is stored in Roboto for discovery and processing.

Parameters:: data (Any)

dataset_id: str#: ID of the dataset to import the file into.

description: str | None = None#: Optional human-readable description of the file.

metadata: dict[str, Any] | None = None#: Optional key-value metadata pairs to associate with the file.

relative_path: str#: Path of the file relative to the dataset root (e.g., logs/session1.bag).

size: int | None = None#: Size of the file in bytes. When importing a single file, you can omit the size, as Roboto will look up the size from the object store. When calling import_batch, you must provide the size explicitly.

tags: list[str] | None = None#: Optional list of tags for file discovery and organization.

uri: str#

//bucket/path/to/file.bag`).

Type:: Storage URI where the file is located (e.g., `s3

class roboto.domain.files.operations.QueryFilesRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload for querying files with filters.

Used to search for files based on various criteria such as metadata, tags, ingestion status, and other file properties. The filters are applied server-side to efficiently return matching files.

Parameters:: data (Any)

filters: dict[str, Any] = None#: Dictionary of filter criteria to apply when searching for files.

model_config#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class roboto.domain.files.operations.RenameFileRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload for renaming a file within its dataset.

Changes the relative path of a file within its dataset. This updates the file’s logical location but does not move the actual file content in storage.

Parameters:: data (Any)

association_id: str#: ID of the dataset containing the file to rename.

new_path: str#: New relative path for the file within the dataset.

class roboto.domain.files.operations.SignedUrlResponse(/, **data)#

Bases: pydantic.BaseModel

Response containing a signed URL for direct file access.

Provides a time-limited URL that allows direct access to file content without requiring Roboto authentication. Used for file downloads and integration with external systems.

Parameters:: data (Any)

url: str#: Signed URL that provides temporary direct access to the file.

class roboto.domain.files.operations.UpdateFileRecordRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload for updating file record properties.

Used to modify file metadata, description, and ingestion status. Only specified fields are updated; others remain unchanged. Uses NotSet sentinel values to distinguish between explicit None values and fields that should not be modified.

Parameters:: data (Any)

description: str | roboto.sentinels.NotSetType | None#: New description for the file, or NotSet to leave unchanged.

ingestion_complete: Literal[True] | roboto.sentinels.NotSetType#: Set to True to mark file as fully ingested, or NotSet to leave unchanged.

metadata_changeset: roboto.updates.MetadataChangeset | roboto.sentinels.NotSetType#: Metadata changes to apply (add, update, or remove fields/tags), or NotSet to leave unchanged.

model_config#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].