roboto.domain.collections.record

Module Contents

CollectionChangeRecord

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

Bases: pydantic.BaseModel

A wire-transmissible representation of a collection change record

Parameters

data Any

Attributes

CollectionChangeRecord.applied

applied datetime.datetime #

CollectionChangeRecord.applied_by

applied_by str #

CollectionChangeRecord.change_set

change_set CollectionChangeSet #

CollectionChangeRecord.collection_id

collection_id str #

CollectionChangeRecord.from_version

from_version int #

CollectionChangeRecord.to_version

to_version int #

CollectionChangeSet

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

Bases: pydantic.BaseModel

Changeset for updating a collection

Parameters

data Any

Attributes

CollectionChangeSet.added_resources

added_resources list[CollectionResourceRef] = None #

CollectionChangeSet.added_tags

added_tags list[str] = None #

CollectionChangeSet.field_changes

field_changes dict[str, Any] = None #

CollectionChangeSet.removed_resources

removed_resources list[CollectionResourceRef] = None #

CollectionChangeSet.removed_tags

removed_tags list[str] = None #

CollectionContentMode

class roboto.domain.collections.record.CollectionContentMode#

Bases: roboto.compat.StrEnum

Desired content mode for representing a collection

Attributes

CollectionContentMode.Full

Full = 'full' #

CollectionContentMode.References

References = 'references' #

CollectionContentMode.SummaryOnly

SummaryOnly = 'summary_only' #

CollectionRecord

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

Bases: pydantic.BaseModel

A wire-transmissible representation of a collection

Parameters

data Any

Attributes

CollectionRecord.collection_id

collection_id str #

CollectionRecord.created

created datetime.datetime #

CollectionRecord.created_by

created_by str #

CollectionRecord.custom_fields

custom_fields dict[str, Any] = None #

Values for the custom fields defined on Collections in this org.

Every Ready custom field defined for (org_id, Collection) appears as a key; values that have not been set surface as None rather than being absent. Empty when no custom fields are defined for the org.

CollectionRecord.description

description str | None = None #

CollectionRecord.missing

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

CollectionRecord.name

name str | None = None #

CollectionRecord.org_id

org_id str #

CollectionRecord.resource_count

resource_count int = 0 #

Number of resources the collection holds.

Maintained by the service as members are added and removed, so it is present in every content mode, including summary_only where resources is empty. Counts every membership reference, including references to resources that have since been deleted; hydrating the collection (content_mode=full) sorts those into missing, so the hydrated resources map can hold fewer entries than this count.

CollectionRecord.resource_type

resource_type CollectionResourceType #

CollectionRecord.resources

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

CollectionRecord.tags

tags list[str] = [] #

CollectionRecord.updated

updated datetime.datetime #

CollectionRecord.updated_by

updated_by str #

CollectionRecord.version

version int #

CollectionResourceRef

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

Bases: pydantic.BaseModel

Reference to a collection resource

Parameters

data Any

Attributes

CollectionResourceRef.resource_id

resource_id str #

CollectionResourceRef.resource_type

resource_type CollectionResourceType #

CollectionResourceRef.resource_version

resource_version str | None = None #

CollectionResourceType

class roboto.domain.collections.record.CollectionResourceType#

Bases: roboto.compat.StrEnum

Type of resource added to a collection

Attributes

CollectionResourceType.Dataset

Dataset = 'dataset' #

CollectionResourceType.Event

Event = 'event' #

CollectionResourceType.File

File = 'file' #

CollectionResourceType.Session

Session = 'session' #