Collection
Collection Objects
Represents collections in Index. Collections are a logical grouping of data items that can be used to create datasets and perform various data curation flows.
uuid
Get the collection unique identifier (UUID).
Returns:
UUID
- The collection UUID.
name
Get the collection name.
Returns:
str
- The collection name.
description
Get the collection description.
Returns:
Optional[str]
- The collection description, or None if not available.
created_at
Get the collection creation timestamp.
Returns:
Optional[datetime]
- The timestamp when the collection was created, or None if not available.
last_edited_at
Get the collection last edit timestamp.
Returns:
Optional[datetime]
- The timestamp when the collection was last edited, or None if not available.
top_level_folder_uuid
Get the uuid of the top level folder that the collection is on.
Returns:
UUID
- the uuid of the top level folder that the collection is on
update_collection
Update the collection’s name and/or description.
Arguments:
name
Optional[str] - The new name for the collection.description
Optional[str] - The new description for the collection.
list_items
List storage items in the collection.
Arguments:
page_size
Optional[int] - The number of items to fetch per page.
Returns:
Iterator[StorageItem]
- An iterator containing storage items in the collection.
list_items_include_inaccessible
List storage items in the collection, including those that are inaccessible.
Arguments:
page_size
Optional[int] - The number of items to fetch per page.
Returns:
Iterator[Union[StorageItem, StorageItemInaccessible]]: An iterator containing both accessible and inaccessible storage items in the collection.
add_items
Add storage items to the collection.
Arguments:
storage_item_uuids
Sequence[Union[UUID, str]] - The list of storage item UUIDs to be added. Either UUIDs or string representations of UUIDs are accepted.
Returns:
CollectionBulkItemResponse
- The response after adding items to the collection.
remove_items
Remove storage items from the collection.
Arguments:
storage_item_uuids
Sequence[Union[UUID, str]] - The list of storage item UUIDs to be removed. Either UUIDs or string representations of UUIDs are accepted.
Returns:
CollectionBulkItemResponse
- The response after removing items from the collection.
add_preset_items
Async operation to add storage items matching a filter preset to the collection.
Arguments:
filter_preset
Union[FilterPreset, UUID, str] - The filter preset or its UUID/ID used to filter items.
remove_preset_items
Async operation to remove storage items matching a filter preset from the collection.
Arguments:
filter_preset
Union[FilterPreset, UUID, str] - The filter preset or its UUID/ID used to filter items.
Was this page helpful?