roboto.domain.collections.record

Module Contents

class roboto.domain.collections.record.CollectionChangeRecord(/, **data)

Bases: pydantic.BaseModel

A wire-transmissible representation of a collection change record

Parameters:

data (Any)

applied: datetime.datetime

applied_by: str

change_set: CollectionChangeSet

collection_id: str

from_version: int

to_version: int

class roboto.domain.collections.record.CollectionChangeSet(/, **data)

Bases: pydantic.BaseModel

Changeset for updating a collection

Parameters:

data (Any)

added_resources: list[CollectionResourceRef] = None

added_tags: list[str] = None

field_changes: dict[str, Any] = None

removed_resources: list[CollectionResourceRef] = None

removed_tags: list[str] = None

class roboto.domain.collections.record.CollectionContentMode

Bases: str, enum.Enum

Desired content mode for representing a collection

Full = 'full'

References = 'references'

SummaryOnly = 'summary_only'

class roboto.domain.collections.record.CollectionRecord(/, **data)

Bases: pydantic.BaseModel

A wire-transmissible representation of a collection

Parameters:

data (Any)

collection_id: str

created: datetime.datetime

created_by: str

description: str | None = None

missing: dict[CollectionResourceType, list[CollectionResourceRef]] = None

name: str | None = None

org_id: str

resources: dict[CollectionResourceType, list[Any]] = None

tags: list[str] = []

updated: datetime.datetime

updated_by: str

version: int

class roboto.domain.collections.record.CollectionResourceRef(/, **data)

Bases: pydantic.BaseModel

Reference to a collection resource

Parameters:

data (Any)

resource_id: str

resource_type: CollectionResourceType

resource_version: str | None = None

class roboto.domain.collections.record.CollectionResourceType

Bases: str, enum.Enum

Type of resource added to a collection

Dataset = 'dataset'

File = 'file'