filespace_models

LucidLink Python Library - Filespace Type Definitions

Types for filespace identity and configuration.

dataclass

lucidlink.filespace_models.CacheConfig

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.

Attribute	Type	Description
`data_bytes`	`Optional[int]`	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`	`Optional[int]`	Initial metadata cache size in bytes, applied atomically during link. None keeps the configured default.

data_bytes

Type: Optional[int]
Description: 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

Type: Optional[int]
Description: Initial metadata cache size in bytes, applied atomically during link. None keeps the configured default.

dataclass

lucidlink.filespace_models.FilespaceInfo

Summary information for a filespace in a workspace listing.

Returned by Workspace.list_filespaces().

Attribute	Type	Description
`id`	`str`	Unique filespace identifier.
`name`	`str`	Human-readable filespace name.
`created`	`str`	Creation timestamp (ISO 8601).

id

Type: str
Description: Unique filespace identifier.

name

Type: str
Description: Human-readable filespace name.

created

Type: str
Description: Creation timestamp (ISO 8601).

enum

lucidlink.filespace_models.SyncMode

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

Member	Value	Description
`SYNC_NONE`	`'none'`	Do not sync automatically — caller must call sync_all() explicitly.
`SYNC_ALL`	`'all'`	(default) Automatically call sync_all() before unlinking filespaces.

SYNC_NONE

Value: 'none'
Description: Do not sync automatically — caller must call sync_all() explicitly.

SYNC_ALL

Value: 'all'
Description: (default) Automatically call sync_all() before unlinking filespaces.