Original File¶
-
class
pyrefinebio.
OriginalFile
(id=None, filename=None, size_in_bytes=None, sha1=None, samples=None, processor_jobs=None, downloader_jobs=None, source_url=None, source_filename=None, is_downloaded=None, is_archive=None, has_raw=None, created_at=None, last_modified=None)¶ Original File.
Retrieve an OriginalFile by id
>>> import pyrefinebio >>> id = 1 >>> og_file = pyrefinebio.OriginalFile.get(id)
Retrieve a list of OriginalFiles based on filters
>>> import pyrefinebio >>> og_files = pyrefinebio.OriginalFile.search()
-
classmethod
get
(id)¶ Retrieve an OriginalFile based on id
- Returns:
OriginalFile
- Parameters:
id (int) – the id for the OriginalFile you want to get
-
classmethod
search
(**kwargs)¶ Retrieve a list of OriginalFiles based on various filters
- Returns:
list of OriginalFile
- Keyword Arguments:
id (int) – filter based on the id of the OriginalFile
filename (str) – filter based on the name of the OriginalFile
samples (str) – filter based on the Samples associated with the OriginalFile
size_in_bytes (int) – filter based on the OriginalFile’s size
sha1 (str) – filter based on the OriginalFiles sha1 hash
processor_jobs (str) – filter based on the ProcessorJobs associated with the OriginalFile
downloader_jobs (str) – filter based on the DownloaderJobs associated with the OriginalFile
source_url (str) – filter based on the OriginalFile’s source url
is_archive (bool) – filter based on if the OriginalFile is archived
source_filename (str) – filter based on the OriginalFile’s source’s filename
has_raw (bool) – filter based on if the OriginalFile had raw data available in the source database
created_at (str) – filter based on the time when the OriginalFile was created
last_modified (str) – filter based on the time when the OriginalFile was last modified
ordering (str) – which field to use when ordering the results.
limit (int) – number of results to return per page.
offset (int) – the initial index from which to return the results.
-
classmethod