filespace_models

LucidLink Python Library - Filespace Type Definitions

Types for filespace identity and configuration.

class lucidlink.filespace_models.CacheConfig(data_bytes: int | None = None, metadata_bytes: int | None = None)[source]

Bases: object

Initial cache sizes to apply atomically when linking a filespace.

Passed to Workspace.link_filespace(cache=...). Each field is optional and independent; a field left as None leaves the configured default in place. Sizes are in bytes.

data_bytes: int | None = None: Initial data cache size in bytes (must be a multiple of 1 MiB). Applied atomically during link; an invalid value rolls the link back and raises. None keeps the configured default.

metadata_bytes: int | None = None: Initial metadata cache size in bytes, applied atomically during link. None keeps the configured default.

class lucidlink.filespace_models.FilespaceInfo(id: str, name: str, created: str)[source]

Bases: object

Summary information for a filespace in a workspace listing.

Returned by Workspace.list_filespaces().

created: str: Creation timestamp (ISO 8601).

id: str: Unique filespace identifier.

name: str: Human-readable filespace name.

class lucidlink.filespace_models.SyncMode(*values)[source]

Bases: Enum

Controls whether changes are automatically synchronized to LucidLink services on close.

SYNC_ALL = 'all': (default) Automatically call sync_all() before unlinking filespaces.

SYNC_NONE = 'none': Do not sync automatically — caller must call sync_all() explicitly.