CollectionArchiveRequest

class pydelfini.delfini_core.models.collection_archive_request.CollectionArchiveRequest(in_folder=Unset, item_ids=Unset, tabular_format=CollectionArchiveRequestTabularFormat.QUERY)[source]

Bases: object

Selects what the archive contains. An empty request means the whole collection version; itemIds limits it to those items, and inFolder to a folder’s contents, recursively.

Attributes:
in_folder (Union[Unset, str]): ID of the folder whose contents, recursively, to include.

ROOT means the whole collection version.

item_ids (Union[Unset, List[str]]): IDs of the items to include. tabular_format (Union[Unset, CollectionArchiveRequestTabularFormat]): How dataviews and links are written.

query (the default) writes each dataview’s query definition and only records links in the manifest, giving the smallest archive. parquet and csv evaluate each dataview and fetch each link, writing tabular results in that format; a link to a non-tabular file is copied as-is.

Default: CollectionArchiveRequestTabularFormat.QUERY.

Attributes

in_folder

item_ids

tabular_format

Parameters:
classmethod from_dict(src_dict)[source]

Create an instance of CollectionArchiveRequest from a dict

Parameters:

src_dict (Dict[str, Any])

Return type:

T

to_dict()[source]

Convert to a dict

Return type:

Dict[str, Any]