roboto.storage.api_operations
Module Contents
AbortTransactionsRequest
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 AnyAttributes
AbortTransactionsRequest.transaction_ids
List of transaction IDs to abort.
BeginSignedUrlUploadRequest
Bases: pydantic.BaseModel
Request payload to begin a single file upload with a signed URL.
Used for simpler upload scenarios where a pre-signed URL is preferred over temporary credentials. The returned URL can be used directly for uploading the file content.
Parameters
data AnyAttributes
BeginSignedUrlUploadRequest.association
The entity this file will be associated with (e.g., dataset, topic).
BeginSignedUrlUploadRequest.file_path
Destination path for the file within the association.
BeginSignedUrlUploadRequest.origination
Optional description of the upload source.
BeginSignedUrlUploadResponse
Bases: pydantic.BaseModel
Response from beginning a single file upload.
Contains the upload ID for completing the transaction and a pre-signed URL that can be used to upload the file content directly.
Parameters
data AnyBeginUploadRequest
Bases: pydantic.BaseModel
Request payload to begin a batch file upload transaction.
Used to initiate a multi-file upload transaction for any association type (dataset, topic, etc.). Returns a transaction ID and upload mappings that specify where each file should be uploaded.
Parameters
data AnyAttributes
BeginUploadRequest.association
The entity these files will be associated with (e.g., dataset, topic).
BeginUploadRequest.device_id
Optional identifier of the device that generated this data.
BeginUploadRequest.origination
Description of the upload source (e.g., ‘roboto-sdk v1.0.0’).
BeginUploadRequest.resource_manifest
Dictionary mapping destination file paths to file sizes in bytes.
BeginUploadResponse
Bases: pydantic.BaseModel
Response from beginning a batch upload transaction.
Contains the transaction ID needed for subsequent progress reporting and completion calls, plus mappings from file paths to their upload URIs.
Parameters
data AnyReportUploadProgressRequest
Bases: pydantic.BaseModel
Request payload for reporting file upload progress.
Used to notify the platform about the completion status of individual files within a batch upload transaction. This enables progress tracking and partial completion handling for large file uploads.
Parameters
data AnyAttributes
ReportUploadProgressRequest.manifest_items
List of file URIs that have completed upload.
ReportUploadProgressResponseItem
Bases: pydantic.BaseModel
One file marked available by a progress report.
The service returns one item per reported URI that matched a file of the transaction, and omits URIs that matched none; the omission does not fail the request on the server side. UploadTransaction is stricter with the response it receives: every URI it reports comes from the transaction’s own upload mappings, so a missing pair means client and service disagree about the transaction’s contents, and it raises RobotoInternalException.
Parameters
data Any