Welcome to Gen3 SDK’s documentation!

The README in the Gen3 Python SDK Github Repo contains installation and setup information along with some quickstart scripts. This contains more detailed documentation about the various classes and functions available.

This documentation is mostly auto-generated from the docstrings within the source code.

• Gen3 Auth Helper
  • Gen3Auth
    • Gen3Auth.curl()
    • Gen3Auth.get_access_token()
    • Gen3Auth.get_access_token_from_wts()
    • Gen3Auth.refresh_access_token()
• Gen3 File Class
  • Gen3File
    • Gen3File.delete_file()
    • Gen3File.delete_file_locations()
    • Gen3File.download_single()
    • Gen3File.get_presigned_url()
    • Gen3File.upload_file()
    • Gen3File.upload_file_to_guid()
• Gen3 Index Class
  • Gen3Index
    • Gen3Index.async_create_record()
    • Gen3Index.async_get_record()
    • Gen3Index.async_get_records_from_checksum()
    • Gen3Index.async_get_records_on_page()
    • Gen3Index.async_get_with_params()
    • Gen3Index.async_query_urls()
    • Gen3Index.async_update_record()
    • Gen3Index.create_blank()
    • Gen3Index.create_new_version()
    • Gen3Index.create_record()
    • Gen3Index.delete_record()
    • Gen3Index.get()
    • Gen3Index.get_all_records()
    • Gen3Index.get_guids_prefix()
    • Gen3Index.get_latest_version()
    • Gen3Index.get_record()
    • Gen3Index.get_record_doc()
    • Gen3Index.get_records()
    • Gen3Index.get_records_on_page()
    • Gen3Index.get_stats()
    • Gen3Index.get_urls()
    • Gen3Index.get_valid_guids()
    • Gen3Index.get_version()
    • Gen3Index.get_versions()
    • Gen3Index.get_with_params()
    • Gen3Index.is_healthy()
    • Gen3Index.query_urls()
    • Gen3Index.update_blank()
    • Gen3Index.update_record()
• Gen3 Jobs Class
  • Gen3Jobs
    • Gen3Jobs.async_run_job_and_wait()
    • Gen3Jobs.create_job()
    • Gen3Jobs.get_output()
    • Gen3Jobs.get_status()
    • Gen3Jobs.get_version()
    • Gen3Jobs.is_healthy()
    • Gen3Jobs.list_jobs()
• Gen3 Metadata Class
  • Gen3Metadata
    • Gen3Metadata.endpoint
    • Gen3Metadata.auth_provider
    • Gen3Metadata.async_create()
    • Gen3Metadata.async_create_aliases()
    • Gen3Metadata.async_delete_alias()
    • Gen3Metadata.async_delete_aliases()
    • Gen3Metadata.async_get()
    • Gen3Metadata.async_get_aliases()
    • Gen3Metadata.async_update()
    • Gen3Metadata.async_update_aliases()
    • Gen3Metadata.batch_create()
    • Gen3Metadata.create()
    • Gen3Metadata.create_aliases()
    • Gen3Metadata.create_index_key_path()
    • Gen3Metadata.delete()
    • Gen3Metadata.delete_alias()
    • Gen3Metadata.delete_aliases()
    • Gen3Metadata.delete_index_key_path()
    • Gen3Metadata.get()
    • Gen3Metadata.get_aliases()
    • Gen3Metadata.get_index_key_paths()
    • Gen3Metadata.get_version()
    • Gen3Metadata.is_healthy()
    • Gen3Metadata.query()
    • Gen3Metadata.update()
    • Gen3Metadata.update_aliases()
• Gen3 Object Class
  • Gen3Object
    • Gen3Object.delete_object()
• Gen3 Query Class
  • Gen3Query
    • Gen3Query.graphql_query()
    • Gen3Query.query()
    • Gen3Query.raw_data_download()
• Gen3 Submission Class
  • Gen3Submission
    • Gen3Submission.create_program()
    • Gen3Submission.create_project()
    • Gen3Submission.delete_node()
    • Gen3Submission.delete_nodes()
    • Gen3Submission.delete_program()
    • Gen3Submission.delete_project()
    • Gen3Submission.delete_record()
    • Gen3Submission.delete_records()
    • Gen3Submission.export_node()
    • Gen3Submission.export_record()
    • Gen3Submission.get_dictionary_all()
    • Gen3Submission.get_dictionary_node()
    • Gen3Submission.get_graphql_schema()
    • Gen3Submission.get_programs()
    • Gen3Submission.get_project_dictionary()
    • Gen3Submission.get_project_manifest()
    • Gen3Submission.get_projects()
    • Gen3Submission.open_project()
    • Gen3Submission.query()
    • Gen3Submission.submit_file()
    • Gen3Submission.submit_record()
• Gen3 Tools
  • DRS Download Tools
    • DownloadManager
      • DownloadManager.cache_hosts_wts_tokens()
      • DownloadManager.download()
      • DownloadManager.get_fresh_token()
      • DownloadManager.resolve_objects()
      • DownloadManager.user_access()
    • DownloadStatus
      • DownloadStatus.status
      • DownloadStatus.start_time
      • DownloadStatus.end_time
    • Downloadable
      • Downloadable.object_id
      • Downloadable.object_type
      • Downloadable.hostname
      • Downloadable.file_size
      • Downloadable.file_name
      • Downloadable.updated_time
      • Downloadable.created_time
      • Downloadable.access_methods
      • Downloadable.children
      • Downloadable._manager
      • Downloadable.download()
      • Downloadable.pprint()
    • Manifest
      • Manifest.object_id
      • Manifest.file_size
      • Manifest.file_name
      • Manifest.md5sum
      • Manifest.commons_url
      • Manifest.create_object_list()
      • Manifest.load()
      • Manifest.load_manifest()
    • download_files_in_drs_manifest()
    • list_access_in_drs_manifest()
    • list_drs_object()
    • list_files_in_drs_manifest()
  • Indexing Tools
    • Download
      • CURRENT_DIR
      • INDEXD_RECORD_PAGE_SIZE
      • MAX_CONCURRENT_REQUESTS
      • TMP_FOLDER
      • async_download_object_manifest()
    • Index
      • CURRENT_DIR
      • GUID
      • SIZE
      • MD5
      • ACLS
      • URLS
      • AUTHZ
      • PREV_GUID
      • ThreadControl
      • delete_all_guids()
      • index_object_manifest()
    • Verify
      • CURRENT_DIR
      • MAX_CONCURRENT_REQUESTS
      • async_verify_object_manifest()
  • Metadata Tools
    • Ingest
      • COLUMN_TO_USE_AS_GUID
      • GUID_TYPE_FOR_INDEXED_FILE_OBJECT
      • GUID_TYPE_FOR_NON_INDEXED_FILE_OBJECT
      • MAX_CONCURRENT_REQUESTS
      • async_ingest_metadata_manifest()
      • async_query_urls_from_indexd()
• Gen3 Workspace Storage
  • Gen3WsStorage
    • Gen3WsStorage.copy()
    • Gen3WsStorage.download()
    • Gen3WsStorage.download_url()
    • Gen3WsStorage.ls()
    • Gen3WsStorage.ls_path()
    • Gen3WsStorage.rm()
    • Gen3WsStorage.rm_path()
    • Gen3WsStorage.upload()
    • Gen3WsStorage.upload_url()

Indices and tables

• Index

• Module Index

• Search Page