Beta documentation

This is the documentation of the Python SDK Beta (0.15.0 and earlier), which is no longer updated. For 1.0 and later, see the LucidLink Developer Portal; to upgrade, follow the migration guide.

Index

A

AbstractFileSystem (class in lucidlink.fsspec) access_key (lucidlink.connect_models.DataStoreInfo attribute) (lucidlink.connect_models.S3Credentials attribute) (lucidlink.connect_models.S3DataStoreConfig attribute)

add_data_store() (lucidlink.connect.ConnectManager method) add_http_link_data_store() (lucidlink.connect.ConnectManager method) are_data_stores_available() (lucidlink.connect.ConnectManager method) authenticate() (lucidlink.daemon.Daemon method) AuthenticationError

B

bucket_name (lucidlink.connect_models.DataStoreInfo attribute) (lucidlink.connect_models.S3DataStoreConfig attribute)

C

cache (lucidlink.client.ClientConfig attribute) (lucidlink.ClientConfig attribute) CacheConfig (class in lucidlink.filespace_models) cat() (lucidlink.fsspec.LucidLinkFileSystem method) cat_file() (lucidlink.fsspec.LucidLinkFileSystem method) Client (class in lucidlink) (class in lucidlink.client) ClientConfig (class in lucidlink) (class in lucidlink.client) ClientError close() (lucidlink.Client method) (lucidlink.client.Client method) (lucidlink.filesystem.FileHandle method) (lucidlink.fsspec.LucidLinkFileSystem method) (lucidlink.stream.LucidFileStream method)

closed (lucidlink.filesystem.FileHandle property) (lucidlink.stream.LucidFileStream property) ConfigurationError connect (lucidlink.filespace.Filespace property) ConnectManager (class in lucidlink.connect) count_external_files() (lucidlink.connect.ConnectManager method) create() (lucidlink.filesystem.Filesystem method) create_daemon() (in module lucidlink) create_dir() (lucidlink.filesystem.Filesystem method) create_hard_link() (lucidlink.filesystem.Filesystem method) create_symlink() (lucidlink.filesystem.Filesystem method) created (lucidlink.filespace_models.FilespaceInfo attribute) ctime (lucidlink.filesystem_models.DirEntry attribute) cursor (lucidlink.connect_models.LinkedFilesResult attribute)

D

Daemon (class in lucidlink.daemon) DaemonError DaemonStatus (class in lucidlink.daemon_models) data (lucidlink.filesystem_models.FilespaceSize attribute) data_bytes (lucidlink.filespace_models.CacheConfig attribute) data_size (lucidlink.filesystem_models.FilespaceStatistics attribute) DataStoreCredentials (in module lucidlink.connect_models)

DataStoreInfo (class in lucidlink.connect_models) DataStoreKind (class in lucidlink.connect_models) DataStoreRekeyState (class in lucidlink.connect_models) delete() (lucidlink.filesystem.Filesystem method) delete_dir() (lucidlink.filesystem.Filesystem method) dir_exists() (lucidlink.filesystem.Filesystem method) directory_count (lucidlink.filesystem_models.FilespaceStatistics attribute) DirEntry (class in lucidlink.filesystem_models)

E

endpoint (lucidlink.connect_models.DataStoreInfo attribute) (lucidlink.connect_models.S3DataStoreConfig attribute) entries (lucidlink.connect_models.LinkedFilesResult attribute) (lucidlink.filesystem_models.FilespaceSize attribute) entries_size (lucidlink.filesystem_models.FilespaceStatistics attribute) entry_id (lucidlink.connect_models.LinkedFile attribute) (lucidlink.filesystem_models.DirEntry attribute)

exists() (lucidlink.fsspec.LucidLinkFileSystem method) external_files_count (lucidlink.filesystem_models.FilespaceSize attribute) (lucidlink.filesystem_models.FilespaceStatistics attribute) external_files_size (lucidlink.filesystem_models.FilespaceSize attribute) (lucidlink.filesystem_models.FilespaceStatistics attribute)

F

file_count (lucidlink.filesystem_models.FilespaceStatistics attribute) file_exists() (lucidlink.filesystem.Filesystem method) file_id (lucidlink.filesystem_models.DirEntry attribute) file_id_external (lucidlink.filesystem_models.DirEntry attribute) file_ids (lucidlink.connect_models.LinkedFilesResult attribute) file_paths (lucidlink.connect_models.LinkedFilesResult attribute) FileHandle (class in lucidlink.filesystem) fileno() (lucidlink.stream.LucidFileStream method) Filespace (class in lucidlink.filespace)

FilespaceAlreadyLinkedError FilespaceError FilespaceInfo (class in lucidlink.filespace_models) FilespaceInternalError FilespaceSize (class in lucidlink.filesystem_models) FilespaceStatistics (class in lucidlink.filesystem_models) Filesystem (class in lucidlink.filesystem) from_dict() (lucidlink.connect_models.DataStoreInfo class method) fs (lucidlink.filespace.Filespace property) full_name (lucidlink.filespace.Filespace property)

G

get() (lucidlink.fsspec.LucidLinkFileSystem method) get_data_cache_size() (lucidlink.filespace.Filespace method) get_data_store() (lucidlink.connect.ConnectManager method) get_entry() (lucidlink.filesystem.Filesystem method) get_metadata_cache_size() (lucidlink.filespace.Filespace method)

get_root_path() (lucidlink.storage.StorageConfig method) get_size() (lucidlink.filesystem.Filesystem method) get_statistics() (lucidlink.filesystem.Filesystem method) get_workspace() (lucidlink.Client method) (lucidlink.client.Client method)

H

has_more (lucidlink.connect_models.LinkedFilesResult attribute)

HTTP_LINK (lucidlink.connect_models.DataStoreKind attribute)

I

id (lucidlink.filespace.Filespace property) (lucidlink.filespace_models.FilespaceInfo attribute) (lucidlink.workspace.Workspace property) (lucidlink.workspace_models.WorkspaceInfo attribute) IN_PROGRESS (lucidlink.connect_models.DataStoreRekeyState attribute) info() (lucidlink.fsspec.LucidLinkFileSystem method) inode_id (lucidlink.connect_models.LinkedFile attribute) (lucidlink.filesystem_models.DirEntry attribute) is_authenticated (lucidlink.daemon_models.DaemonStatus attribute) is_dir() (lucidlink.filesystem_models.DirEntry method)

is_file() (lucidlink.filesystem_models.DirEntry method) is_link() (lucidlink.filesystem_models.DirEntry method) is_linked (lucidlink.daemon_models.DaemonStatus attribute) (lucidlink.filespace.Filespace property) is_logged_in (lucidlink.Client property) (lucidlink.client.Client property) is_running (lucidlink.daemon_models.DaemonStatus attribute) is_running() (lucidlink.daemon.Daemon method) isatty() (lucidlink.stream.LucidFileStream method) isdir() (lucidlink.fsspec.LucidLinkFileSystem method) isfile() (lucidlink.fsspec.LucidLinkFileSystem method)

K

key_id (lucidlink.connect_models.DataStoreInfo attribute)

kind (lucidlink.connect_models.DataStoreInfo attribute) (lucidlink.connect_models.S3Credentials attribute)

L

link_file() (lucidlink.connect.ConnectManager method) link_filespace() (lucidlink.workspace.Workspace method) link_http_file() (lucidlink.connect.ConnectManager method) linked_filespaces (lucidlink.workspace.Workspace property) LinkedFile (class in lucidlink.connect_models) LinkedFilesResult (class in lucidlink.connect_models) list_data_stores() (lucidlink.connect.ConnectManager method) list_dir() (lucidlink.filesystem.Filesystem method) list_external_files() (lucidlink.connect.ConnectManager method) list_filespaces() (lucidlink.workspace.Workspace method) list_workspaces() (lucidlink.Client method) (lucidlink.client.Client method) lock_byte_range() (lucidlink.filesystem.Filesystem method) login() (lucidlink.Client method) (lucidlink.client.Client method) ls() (lucidlink.fsspec.LucidLinkFileSystem method) LucidFileStream (class in lucidlink.stream) lucidlink module lucidlink.client module lucidlink.connect module lucidlink.connect_models module lucidlink.const module

lucidlink.credentials module lucidlink.daemon module lucidlink.daemon_models module lucidlink.exceptions module lucidlink.filespace module lucidlink.filespace_models module lucidlink.filesystem module lucidlink.filesystem_models module lucidlink.fsspec module lucidlink.storage module lucidlink.stream module lucidlink.workspace module lucidlink.workspace_models module LucidLinkError LucidLinkFileSystem (class in lucidlink.fsspec)

M

makedirs() (lucidlink.fsspec.LucidLinkFileSystem method) metadata_bytes (lucidlink.filespace_models.CacheConfig attribute) mkdir() (lucidlink.fsspec.LucidLinkFileSystem method) mode (lucidlink.filesystem.FileHandle property) (lucidlink.stream.LucidFileStream property) module lucidlink lucidlink.client lucidlink.connect lucidlink.connect_models lucidlink.const lucidlink.credentials lucidlink.daemon lucidlink.daemon_models lucidlink.exceptions lucidlink.filespace lucidlink.filespace_models lucidlink.filesystem lucidlink.filesystem_models lucidlink.fsspec lucidlink.storage lucidlink.stream lucidlink.workspace lucidlink.workspace_models

move() (lucidlink.filesystem.Filesystem method) mtime (lucidlink.filesystem_models.DirEntry attribute) mv() (lucidlink.fsspec.LucidLinkFileSystem method)

N

name (lucidlink.connect_models.DataStoreInfo attribute) (lucidlink.filespace.Filespace property) (lucidlink.filespace_models.FilespaceInfo attribute) (lucidlink.filesystem_models.DirEntry attribute) (lucidlink.stream.LucidFileStream property) (lucidlink.workspace.Workspace property) (lucidlink.workspace_models.WorkspaceInfo attribute)

NO_REKEY (lucidlink.connect_models.DataStoreRekeyState attribute) num_hard_links (lucidlink.filesystem_models.DirEntry attribute)

O

open() (lucidlink.filesystem.Filesystem method) open_buffered() (in module lucidlink.stream)

open_legacy() (lucidlink.filesystem.Filesystem method) open_text() (in module lucidlink.stream) options (lucidlink.fsspec.LucidLinkFileSystem property)

P

path (lucidlink.connect_models.LinkedFile attribute) (lucidlink.filesystem.FileHandle property)

PHYSICAL (lucidlink.storage.StorageMode attribute) protocol (lucidlink.fsspec.LucidLinkFileSystem attribute) put() (lucidlink.fsspec.LucidLinkFileSystem method)

R

read() (lucidlink.filesystem.FileHandle method) (lucidlink.stream.LucidFileStream method) read_dir() (lucidlink.filesystem.Filesystem method) read_file() (lucidlink.filesystem.Filesystem method) read_symlink() (lucidlink.filesystem.Filesystem method) readable() (lucidlink.stream.LucidFileStream method) readinto() (lucidlink.stream.LucidFileStream method) region (lucidlink.connect_models.DataStoreInfo attribute) (lucidlink.connect_models.S3DataStoreConfig attribute)

rekey_data_store() (lucidlink.connect.ConnectManager method) rekey_state (lucidlink.connect_models.DataStoreInfo attribute) remove_data_store() (lucidlink.connect.ConnectManager method) rename() (lucidlink.fsspec.LucidLinkFileSystem method) rm() (lucidlink.fsspec.LucidLinkFileSystem method) rmdir() (lucidlink.fsspec.LucidLinkFileSystem method) root_path (lucidlink.daemon_models.DaemonStatus attribute)

S

S3 (lucidlink.connect_models.DataStoreKind attribute) S3Credentials (class in lucidlink.connect_models) S3DataStoreConfig (class in lucidlink.connect_models) SANDBOXED (lucidlink.storage.StorageMode attribute) secret_key (lucidlink.connect_models.DataStoreInfo attribute) (lucidlink.connect_models.S3Credentials attribute) (lucidlink.connect_models.S3DataStoreConfig attribute) seek() (lucidlink.stream.LucidFileStream method) seekable() (lucidlink.stream.LucidFileStream method) ServiceAccountCredentials (class in lucidlink.credentials) should_cleanup() (lucidlink.storage.StorageConfig method) size (lucidlink.filesystem_models.DirEntry attribute)

start() (lucidlink.daemon.Daemon method) stop() (lucidlink.daemon.Daemon method) (lucidlink.workspace.Workspace method) storage (lucidlink.filesystem_models.FilespaceSize attribute) storage_size (lucidlink.filesystem_models.FilespaceStatistics attribute) StorageConfig (class in lucidlink.storage) StorageMode (class in lucidlink.storage) symlink_count (lucidlink.filesystem_models.FilespaceStatistics attribute) SYNC_ALL (lucidlink.filespace_models.SyncMode attribute) sync_all() (lucidlink.filespace.Filespace method) (lucidlink.fsspec.LucidLinkFileSystem method) SYNC_NONE (lucidlink.filespace_models.SyncMode attribute) SyncMode (class in lucidlink.filespace_models)

T

tell() (lucidlink.stream.LucidFileStream method) truncate() (lucidlink.filesystem.Filesystem method) (lucidlink.stream.LucidFileStream method)

type (lucidlink.filesystem_models.DirEntry attribute)

U

unlink() (lucidlink.filespace.Filespace method) unlink_file() (lucidlink.connect.ConnectManager method) unlink_filespace() (lucidlink.workspace.Workspace method) unlock_all_byte_ranges() (lucidlink.filesystem.Filesystem method) unlock_byte_range() (lucidlink.filesystem.Filesystem method)

update_http_file_url() (lucidlink.connect.ConnectManager method) url_expiration_minutes (lucidlink.connect_models.DataStoreInfo attribute) (lucidlink.connect_models.S3DataStoreConfig attribute) use_virtual_addressing (lucidlink.connect_models.DataStoreInfo attribute) (lucidlink.connect_models.S3DataStoreConfig attribute)

W

Workspace (class in lucidlink.workspace) workspace_id (lucidlink.filespace.Filespace property) workspace_name (lucidlink.filespace.Filespace property) WorkspaceInfo (class in lucidlink.workspace_models)

writable() (lucidlink.stream.LucidFileStream method) write() (lucidlink.filesystem.FileHandle method) (lucidlink.stream.LucidFileStream method) write_file() (lucidlink.filesystem.Filesystem method)