Skip to main content

connect_models

Data models for LucidLink Connect (external files).

dataclass

lucidlink.connect_models.DataStoreInfo

Information about a registered data store.

Attribute

Type

Description

name

str

Data store name.

access_key

str

S3 access key ID.

secret_key

str

S3 secret access key.

bucket_name

str

S3 bucket name.

region

str

AWS region.

endpoint

str

Full S3 endpoint URL (e.g., "http://127.0.0.1:9090"), empty if using AWS default.

url_expiration_minutes

int

Presigned URL expiration in minutes.

use_virtual_addressing

bool

Whether virtual-hosted-style addressing is used.

kind

DataStoreKind

Data store type (currently always S3).

key_id

str

Unique key identifier (UUID).

rekey_state

DataStoreRekeyState

Current credential rotation state.

name

Type

str

Description

Data store name.

access_key

Type

str

Description

S3 access key ID.

secret_key

Type

str

Description

S3 secret access key.

bucket_name

Type

str

Description

S3 bucket name.

region

Type

str

Description

AWS region.

endpoint

Type

str

Description

Full S3 endpoint URL (e.g., "http://127.0.0.1:9090"), empty if using AWS default.

url_expiration_minutes

Type

int

Description

Presigned URL expiration in minutes.

use_virtual_addressing

Type

bool

Description

Whether virtual-hosted-style addressing is used.

kind

Description

Data store type (currently always S3).

key_id

Type

str

Description

Unique key identifier (UUID).

rekey_state

Description

Current credential rotation state.

method

from_dict(store: dict) -> 'DataStoreInfo'

enum

lucidlink.connect_models.DataStoreKind

Type of external data store.

Member

Value

Description

S3

'S3DataStore'

Amazon S3 or S3-compatible object storage.

S3

Value

'S3DataStore'

Description

Amazon S3 or S3-compatible object storage.

enum

lucidlink.connect_models.DataStoreRekeyState

Credential rotation state for a data store.

Member

Value

Description

NO_REKEY

'no_rekey'

No credential rotation in progress.

IN_PROGRESS

'in_progress'

Credential rotation is currently in progress.

NO_REKEY

Value

'no_rekey'

Description

No credential rotation in progress.

IN_PROGRESS

Value

'in_progress'

Description

Credential rotation is currently in progress.

dataclass

lucidlink.connect_models.LinkedFilesResult

Result from listing external files linked to a data store.

Attribute

Type

Description

file_paths

List[str]

List of file paths.

file_ids

List[int]

List of integer file IDs (parallel to file_paths).

has_more

bool

Whether more results are available (pagination).

cursor

str

Opaque pagination token; pass to the next call to continue.

file_paths

Type

List[str]

Description

List of file paths.

file_ids

Type

List[int]

Description

List of integer file IDs (parallel to file_paths).

has_more

Type

bool

Description

Whether more results are available (pagination).

cursor

Type

str

Description

Opaque pagination token; pass to the next call to continue.

dataclass

lucidlink.connect_models.S3Credentials

Attribute

Type

Description

access_key

str

secret_key

str

kind

DataStoreKind

access_key

Type

str

Description

secret_key

Type

str

Description

kind

Description

dataclass

lucidlink.connect_models.S3DataStoreConfig

Configuration for an S3-compatible data store.

Attribute

Type

Description

access_key

str

S3 access key ID.

secret_key

str

S3 secret access key.

bucket_name

str

S3 bucket name.

region

str

AWS region (e.g., "us-east-1").

endpoint

str

Custom S3 endpoint URL with scheme, e.g. "http://127.0.0.1:9090". Must start with "http://" or "https://". When empty, defaults to HTTPS.

url_expiration_minutes

int

Presigned URL expiration in minutes (7 days).

use_virtual_addressing

bool

Use virtual-hosted-style addressing.

access_key

Type

str

Description

S3 access key ID.

secret_key

Type

str

Description

S3 secret access key.

bucket_name

Type

str

Description

S3 bucket name.

region

Type

str

Description

AWS region (e.g., "us-east-1").

endpoint

Type

str

Description

Custom S3 endpoint URL with scheme, e.g. "http://127.0.0.1:9090". Must start with "http://" or "https://". When empty, defaults to HTTPS.

url_expiration_minutes

Type

int

Description

Presigned URL expiration in minutes (7 days).

use_virtual_addressing

Type

bool

Description

Use virtual-hosted-style addressing.