roboto.domain.collections

Submodules

• roboto.domain.collections.collection
• roboto.domain.collections.operations
• roboto.domain.collections.record

Package Contents

class roboto.domain.collections.Collection(record, roboto_client=None)

A higher-level container for grouping datasets together. Collections can also be used to group files from several distinct datasets together.

Parameters:

• record (roboto.domain.collections.record.CollectionRecord)

• roboto_client (Optional[roboto.http.RobotoClient])

add_dataset(dataset_id)

Parameters:

dataset_id (str)

Return type:

Collection

add_file(file_id)

Parameters:

file_id (str)

Return type:

Collection

changes(from_version=None, to_version=None)

Parameters:

• from_version (Optional[int])

• to_version (Optional[int])

Return type:

collections.abc.Generator[roboto.domain.collections.record.CollectionChangeRecord, None, None]

property collection_id: str

Return type:

str

classmethod create(description=None, name=None, resources=None, dataset_ids=None, file_ids=None, tags=None, roboto_client=None, caller_org_id=None)

Parameters:

• description (Optional[str])

• name (Optional[str])

• resources (Optional[list[roboto.domain.collections.record.CollectionResourceRef]])

• dataset_ids (Optional[collections.abc.Collection[str]])

• file_ids (Optional[collections.abc.Collection[str]])

• tags (Optional[list[str]])

• roboto_client (Optional[roboto.http.RobotoClient])

• caller_org_id (Optional[str])

Return type:

Collection

property created: datetime.datetime

Return type:

datetime.datetime

property created_by: str

Return type:

str

property datasets: list[str]

Return type:

list[str]

delete()

edit_access(edit)

Parameters:

edit (roboto.auth.EditAccessRequest)

Return type:

roboto.auth.GetAccessResponse

property files: list[str]

Return type:

list[str]

classmethod from_id(collection_id, version=None, content_mode=CollectionContentMode.Full, roboto_client=None)

Parameters:

• collection_id (str)

• version (Optional[int])

• content_mode (roboto.domain.collections.record.CollectionContentMode)

• roboto_client (Optional[roboto.http.RobotoClient])

Return type:

Collection

get_access()

Return type:

roboto.auth.GetAccessResponse

classmethod list_all(roboto_client=None, owner_org_id=None, content_mode=CollectionContentMode.SummaryOnly)

Parameters:

• roboto_client (Optional[roboto.http.RobotoClient])

• owner_org_id (Optional[str])

• content_mode (roboto.domain.collections.record.CollectionContentMode)

Return type:

collections.abc.Generator[Collection, None, None]

property record: roboto.domain.collections.record.CollectionRecord

Return type:

roboto.domain.collections.record.CollectionRecord

remove_dataset(dataset_id)

Parameters:

dataset_id (str)

Return type:

Collection

remove_file(file_id)

Parameters:

file_id (str)

Return type:

Collection

update(add_resources=NotSet, add_tags=NotSet, description=NotSet, name=NotSet, remove_resources=NotSet, remove_tags=NotSet)

Parameters:

• add_resources (Union[list[roboto.domain.collections.record.CollectionResourceRef], roboto.sentinels.NotSetType])

• add_tags (Union[list[str], roboto.sentinels.NotSetType])

• description (Optional[Union[roboto.sentinels.NotSetType, str]])

• name (Optional[Union[roboto.sentinels.NotSetType, str]])

• remove_resources (Union[list[roboto.domain.collections.record.CollectionResourceRef], roboto.sentinels.NotSetType])

• remove_tags (Union[list[str], roboto.sentinels.NotSetType])

Return type:

Collection

property updated: datetime.datetime

Return type:

datetime.datetime

property updated_by: str

Return type:

str

class roboto.domain.collections.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.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.CollectionContentMode

Bases: str, enum.Enum

Desired content mode for representing a collection

Full = 'full'

References = 'references'

SummaryOnly = 'summary_only'

class roboto.domain.collections.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.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.CollectionResourceType

Bases: str, enum.Enum

Type of resource added to a collection

Dataset = 'dataset'

File = 'file'

class roboto.domain.collections.CreateCollectionRequest(/, **data)

Bases: pydantic.BaseModel

Request payload to create a collection

Parameters:

data (Any)

description: str | None = None

name: str | None = None

resources: list[roboto.domain.collections.record.CollectionResourceRef] | None = None

tags: list[str] | None = None

class roboto.domain.collections.UpdateCollectionRequest(/, **data)

Bases: pydantic.BaseModel

Request payload to update a collection

Parameters:

data (Any)

add_resources: list[roboto.domain.collections.record.CollectionResourceRef] | roboto.sentinels.NotSetType

add_tags: list[str] | roboto.sentinels.NotSetType

description: roboto.sentinels.NotSetType | str | None

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: roboto.sentinels.NotSetType | str | None

remove_resources: list[roboto.domain.collections.record.CollectionResourceRef] | roboto.sentinels.NotSetType

remove_tags: list[str] | roboto.sentinels.NotSetType