Skip to content
Roboto
Esc
↑↓navigate↵open⌘Jpreview
On this page

roboto.domain.collections

Submodules

Package Contents

Collection

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

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]

Collection.add_dataset()

add_dataset(dataset_id)#View Source

Parameters

dataset_id str

Return type

Collection

Collection.add_event()

add_event(event_id)#View Source

Parameters

event_id str

Return type

Collection

Collection.add_file()

add_file(file_id)#View Source

Parameters

file_id str

Return type

Collection

Collection.add_session()

add_session(session_id)#View Source

Parameters

session_id str

Return type

Collection

Collection.changes()

changes(from_version=None, to_version=None)#View Source

Yield this collection’s revision history, oldest change first.

Version 0 is a real collection version, so 0 is a bound like any other: from_version=0 starts at the beginning, and to_version=0 selects the empty range. Omit a bound to leave that end open.

Parameters

from_version Optional[int]
to_version Optional[int]

Return type

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

Collection.clear_custom_field()

clear_custom_field(name)#View Source

Clear a single custom-field value on this collection to None.

Parameters

name str

Return type

Collection

Collection.clear_custom_fields()

clear_custom_fields(names)#View Source

Clear multiple custom-field values on this collection to None.

Parameters

names collections.abc.Sequence[str]

Return type

Collection

Properties

Collection.collection_id

collection_id str #
Return type: str

Collection.create()

classmethod create(description=None, name=None, resource_type=CollectionResourceType.File, resources=None, dataset_ids=None, event_ids=None, file_ids=None, session_ids=None, tags=None, custom_fields=None, roboto_client=None, caller_org_id=None)#View Source

Parameters

description Optional[str]
name Optional[str]
resource_type roboto.domain.collections.record.CollectionResourceType
resources Optional[list[roboto.domain.collections.record.CollectionResourceRef]]
dataset_ids Optional[collections.abc.Collection[str]]
event_ids Optional[collections.abc.Collection[str]]
file_ids Optional[collections.abc.Collection[str]]
session_ids Optional[collections.abc.Collection[str]]
tags Optional[list[str]]
custom_fields Optional[dict[str, Any]]
roboto_client Optional[roboto.http.RobotoClient]
caller_org_id Optional[str]

Return type

Collection

Properties

Collection.created

created datetime.datetime #
Return type: datetime.datetime

Collection.created_by

created_by str #
Return type: str

Collection.custom_fields

custom_fields dict[str, Any] #

Custom-field values defined on Collections in this org.

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

A Timestamp value is returned as an ISO 8601 string.

Return type: dict[str, Any]

Collection.datasets

datasets list[str] #
Return type: list[str]

Collection.delete()

delete()#View Source

Properties

Collection.description

description str | None #
Return type: Optional[str]

Collection.edit_access()

edit_access(edit)#View Source

Parameters

edit roboto.auth.EditAccessRequest

Return type

roboto.auth.GetAccessResponse

Properties

Collection.events

events list[str] #
Return type: list[str]

Collection.files

files list[str] #
Return type: list[str]

Collection.from_id()

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

Parameters

collection_id str
version Optional[int]
content_mode roboto.domain.collections.record.CollectionContentMode
roboto_client Optional[roboto.http.RobotoClient]

Return type

Collection

Collection.get_access()

get_access()#View Source

Return type

roboto.auth.GetAccessResponse

Collection.list_all()

classmethod list_all(roboto_client=None, owner_org_id=None, content_mode=CollectionContentMode.SummaryOnly, sort_by=None, sort_direction=None)#View Source

Parameters

roboto_client Optional[roboto.http.RobotoClient]
owner_org_id Optional[str]
content_mode roboto.domain.collections.record.CollectionContentMode
sort_by Optional[str]
sort_direction Optional[roboto.query.SortDirection]

Return type

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

Properties

Collection.name

name str | None #
Return type: Optional[str]

Collection.record

record roboto.domain.collections.record.CollectionRecord #
Return type: roboto.domain.collections.record.CollectionRecord

Collection.remove_dataset()

remove_dataset(dataset_id)#View Source

Parameters

dataset_id str

Return type

Collection

Collection.remove_event()

remove_event(event_id)#View Source

Parameters

event_id str

Return type

Collection

Collection.remove_file()

remove_file(file_id)#View Source

Parameters

file_id str

Return type

Collection

Collection.remove_session()

remove_session(session_id)#View Source

Parameters

session_id str

Return type

Collection

Properties

Collection.resource_count

resource_count int #

Number of resources this collection holds.

Read from the collection record rather than from resources, so it is available in every content mode, including summary-only loads where the member list is empty. Counts every membership reference, including references to resources that have since been deleted.

Return type: int

Collection.sessions

sessions list[str] #
Return type: list[str]

Collection.set_custom_field()

set_custom_field(name, value)#View Source

Set a single custom-field value on this collection.

name must be the name of a Ready custom field for this collection’s org and the Collection entity type; value must satisfy the field’s declared type.

Parameters

name str
value Any

Return type

Collection

Collection.set_custom_fields()

set_custom_fields(fields)#View Source

Set or overwrite multiple custom-field values on this collection.

Each key must name a Ready custom field for this collection’s org and the Collection entity type; each value must satisfy the field’s declared type.

Parameters

fields dict[str, Any]

Return type

Collection

Collection.update()

update(add_resources=NotSet, add_tags=NotSet, description=NotSet, name=NotSet, remove_resources=NotSet, remove_tags=NotSet, custom_fields_changeset=None)#View Source

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]
custom_fields_changeset Optional[roboto.updates.CustomFieldChangeset]

Return type

Collection

Properties

Collection.updated

updated datetime.datetime #
Return type: datetime.datetime

Collection.updated_by

updated_by str #
Return type: str

CollectionChangeRecord

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

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.CollectionChangeSet(/, **data)#View Source

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.CollectionContentMode#View Source

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.CollectionRecord(/, **data)#View Source

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.CollectionResourceRef(/, **data)#View Source

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.CollectionResourceType#View Source

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' #

CreateCollectionRequest

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

Bases: pydantic.BaseModel

Request payload to create a collection

Parameters

data Any

Attributes

CreateCollectionRequest.custom_fields

custom_fields dict[str, Any] | None = None #

Initial values for Ready custom fields on this collection.

Each key must be the name of a CustomField that is Ready for the caller’s org and the Collection entity type; each value must satisfy the field’s declared type. Names that are undefined or not Ready, and values that don’t match the field’s type, are rejected with a structured error.

CreateCollectionRequest.description

description str | None = None #

CreateCollectionRequest.name

name str | None = None #

CreateCollectionRequest.resource_type

resource_type roboto.domain.collections.record.CollectionResourceType #

CreateCollectionRequest.resources

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

CreateCollectionRequest.tags

tags list[str] | None = None #

UpdateCollectionRequest

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

Bases: pydantic.BaseModel

Request payload to update a collection

Parameters

data Any

Attributes

UpdateCollectionRequest.add_resources

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

UpdateCollectionRequest.add_tags

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

UpdateCollectionRequest.custom_fields_changeset

custom_fields_changeset roboto.updates.CustomFieldChangeset | None = None #

Changes to apply to Ready custom-field values on this collection.

Each referenced field name must be a Ready custom field for this collection’s org and the Collection entity type; each set_fields value must satisfy the field’s declared type. Names that are undefined or not Ready are rejected with a structured error. Field names not mentioned by the changeset are left unchanged.

UpdateCollectionRequest.description

description roboto.sentinels.NotSetType | str | None #

UpdateCollectionRequest.model_config

model_config #

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

UpdateCollectionRequest.name

name roboto.sentinels.NotSetType | str | None #

UpdateCollectionRequest.remove_resources

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

UpdateCollectionRequest.remove_tags

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

Was this page helpful?