# 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](https://dev.nominal.io/python/guides/drives/overview.md) for examples.

## API Reference

Module: `nominal.experimental.drives`.

Classes

| [`DirectoryMoveSuccess`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.DirectoryMoveSuccess.md#nominal.experimental.drives.DirectoryMoveSuccess "nominal.experimental.drives.DirectoryMoveSuccess") | A directory move completed; existing file snapshots keep their old paths until refreshed. |
| --- | --- |
| [`Drive`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.Drive.md#nominal.experimental.drives.Drive "nominal.experimental.drives.Drive") | A workspace-scoped namespace for files. |
| [`DriveBatch`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.DriveBatch.md#nominal.experimental.drives.DriveBatch "nominal.experimental.drives.DriveBatch") | Build an ordered batch for one drive, then submit it once. |
| [`DriveDirectory`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.DriveDirectory.md#nominal.experimental.drives.DriveDirectory "nominal.experimental.drives.DriveDirectory") | A directory in a drive listing. |
| [`DriveEntry`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.DriveEntry.md#nominal.experimental.drives.DriveEntry "nominal.experimental.drives.DriveEntry") | Anything a drive listing can yield: a file or a directory. |
| [`DriveFile`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.DriveFile.md#nominal.experimental.drives.DriveFile "nominal.experimental.drives.DriveFile") | A file in a drive, managed or mirrored from an external provider. |
| [`DriveFileRevision`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.DriveFileRevision.md#nominal.experimental.drives.DriveFileRevision "nominal.experimental.drives.DriveFileRevision") | One entry in a managed file's linear history. |
| [`FileChangeFailure`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.FileChangeFailure.md#nominal.experimental.drives.FileChangeFailure "nominal.experimental.drives.FileChangeFailure") | A rejected change, returned in its input position rather than raised. |
| [`FileChangeSuccess`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.FileChangeSuccess.md#nominal.experimental.drives.FileChangeSuccess "nominal.experimental.drives.FileChangeSuccess") | File and revision produced by a successful put, move, remove, or restore. |
| [`ManagedDriveFile`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.ManagedDriveFile.md#nominal.experimental.drives.ManagedDriveFile "nominal.experimental.drives.ManagedDriveFile") | A file stored in a Nominal-backed drive, with a stable RID and a revision history. |
| [`PreparedPut`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.PreparedPut.md#nominal.experimental.drives.PreparedPut "nominal.experimental.drives.PreparedPut") | Uploaded bytes ready to commit with [`DriveBatch.put`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.DriveBatch.md#nominal.experimental.drives.DriveBatch.put "nominal.experimental.drives.DriveBatch.put"). |
| [`VirtualDrive`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.VirtualDrive.md#nominal.experimental.drives.VirtualDrive "nominal.experimental.drives.VirtualDrive") | A read-only drive whose files are mirrored from an external provider. |
| [`VirtualDriveFile`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.VirtualDriveFile.md#nominal.experimental.drives.VirtualDriveFile "nominal.experimental.drives.VirtualDriveFile") | A file mirrored from an external provider, pinned by content rather than by RID. |
| [`VirtualDriveStatus`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.VirtualDriveStatus.md#nominal.experimental.drives.VirtualDriveStatus "nominal.experimental.drives.VirtualDriveStatus") | Connectivity of a virtual drive's backing provider, probed when requested. |

Enumerations

| [`DownloadAvailability`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.DownloadAvailability.md#nominal.experimental.drives.DownloadAvailability "nominal.experimental.drives.DownloadAvailability") | Whether a file or revision's content is available to download. |
| --- | --- |
| [`DriveFileState`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.DriveFileState.md#nominal.experimental.drives.DriveFileState "nominal.experimental.drives.DriveFileState") | Whether a file is present or soft-deleted. |
| [`DriveMutability`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.DriveMutability.md#nominal.experimental.drives.DriveMutability "nominal.experimental.drives.DriveMutability") | Whether a drive's contents can be modified through Nominal. |
| [`DriveSource`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.DriveSource.md#nominal.experimental.drives.DriveSource "nominal.experimental.drives.DriveSource") | Where a drive's files come from: Nominal's own storage, or an external provider. |
| [`DriveState`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.DriveState.md#nominal.experimental.drives.DriveState "nominal.experimental.drives.DriveState") | Lifecycle state of a drive. |
| [`FailurePolicy`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.FailurePolicy.md#nominal.experimental.drives.FailurePolicy "nominal.experimental.drives.FailurePolicy") | Whether a failed change leaves successful changes applied. |
| [`FileStoreErrorCode`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.FileStoreErrorCode.md#nominal.experimental.drives.FileStoreErrorCode "nominal.experimental.drives.FileStoreErrorCode") | Why a drive operation was rejected, by the backend or by this SDK before sending it. |
| [`VirtualDriveState`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.VirtualDriveState.md#nominal.experimental.drives.VirtualDriveState "nominal.experimental.drives.VirtualDriveState") | Connectivity of a virtual drive's backing provider. |

Functions

| [`create_drive`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.create_drive.md#nominal.experimental.drives.create_drive "nominal.experimental.drives.create_drive") | Create a managed drive. |
| --- | --- |
| [`get_drive`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.get_drive.md#nominal.experimental.drives.get_drive "nominal.experimental.drives.get_drive") | Retrieve a drive by RID. |
| [`get_drive_by_id`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.get_drive_by_id.md#nominal.experimental.drives.get_drive_by_id "nominal.experimental.drives.get_drive_by_id") | Retrieve a drive by its workspace-unique id. |
| [`list_drives`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.list_drives.md#nominal.experimental.drives.list_drives "nominal.experimental.drives.list_drives") | List the drives in a workspace. |

Exceptions

| [`NominalFileStoreError`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.NominalFileStoreError.md#nominal.experimental.drives.NominalFileStoreError "nominal.experimental.drives.NominalFileStoreError") | A drive operation was rejected. |
| --- | --- |

Type aliases

| [`FileChangeResult`](https://dev.nominal.io/python/ref/experimental/drives.md#nominal.experimental.drives.FileChangeResult "nominal.experimental.drives.FileChangeResult") | [`FileChangeSuccess`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.FileChangeSuccess.md#nominal.experimental.drives.FileChangeSuccess "nominal.experimental.drives.changes.FileChangeSuccess") | [`DirectoryMoveSuccess`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.DirectoryMoveSuccess.md#nominal.experimental.drives.DirectoryMoveSuccess "nominal.experimental.drives.changes.DirectoryMoveSuccess") | [`FileChangeFailure`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.FileChangeFailure.md#nominal.experimental.drives.FileChangeFailure "nominal.experimental.drives.changes.FileChangeFailure") |
| --- | --- |
| [`FileDestination`](https://dev.nominal.io/python/ref/experimental/drives.md#nominal.experimental.drives.FileDestination "nominal.experimental.drives.FileDestination") | [`str`](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)") | [`ManagedDriveFile`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.ManagedDriveFile.md#nominal.experimental.drives.ManagedDriveFile "nominal.experimental.drives.file.ManagedDriveFile") | [`DriveFileRevision`](https://dev.nominal.io/python/ref/generated/nominal.experimental.drives.DriveFileRevision.md#nominal.experimental.drives.DriveFileRevision "nominal.experimental.drives.file.DriveFileRevision") |
