Nominal Drives#

Store, version, move and download files with nominal.experimental.drives. These APIs are experimental and may change between releases. See the Drives guide for examples.

API Reference#

Module: nominal.experimental.drives.

Classes

DirectoryMoveSuccess

A directory move completed; existing file snapshots keep their old paths until refreshed.

Drive

A workspace-scoped namespace for files.

DriveBatch

Build an ordered batch for one drive, then submit it once.

DriveDirectory

A directory in a drive listing.

DriveEntry

Anything a drive listing can yield: a file or a directory.

DriveFile

A file in a drive, managed or mirrored from an external provider.

DriveFileRevision

One entry in a managed file's linear history.

FileChangeFailure

A rejected change, returned in its input position rather than raised.

FileChangeSuccess

File and revision produced by a successful put, move, remove, or restore.

ManagedDriveFile

A file stored in a Nominal-backed drive, with a stable RID and a revision history.

PreparedPut

Uploaded bytes ready to commit with DriveBatch.put.

VirtualDrive

A read-only drive whose files are mirrored from an external provider.

VirtualDriveFile

A file mirrored from an external provider, pinned by content rather than by RID.

VirtualDriveStatus

Connectivity of a virtual drive's backing provider, probed when requested.

Enumerations

DownloadAvailability

Whether a file or revision's content is available to download.

DriveFileState

Whether a file is present or soft-deleted.

DriveMutability

Whether a drive's contents can be modified through Nominal.

DriveSource

Where a drive's files come from: Nominal's own storage, or an external provider.

DriveState

Lifecycle state of a drive.

FailurePolicy

Whether a failed change leaves successful changes applied.

FileStoreErrorCode

Why a drive operation was rejected, by the backend or by this SDK before sending it.

VirtualDriveState

Connectivity of a virtual drive's backing provider.

Functions

create_drive

Create a managed drive.

get_drive

Retrieve a drive by RID.

get_drive_by_id

Retrieve a drive by its workspace-unique id.

list_drives

List the drives in a workspace.

Exceptions

NominalFileStoreError

A drive operation was rejected.

Type aliases