diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle index 5ba559ae4..0ec5676b5 100644 Binary files a/docs/_build/doctrees/environment.pickle and b/docs/_build/doctrees/environment.pickle differ diff --git a/docs/_build/doctrees/tools/indexing.doctree b/docs/_build/doctrees/tools/indexing.doctree index 546504eb6..d20f0b953 100644 Binary files a/docs/_build/doctrees/tools/indexing.doctree and b/docs/_build/doctrees/tools/indexing.doctree differ diff --git a/docs/_build/doctrees/tools/metadata.doctree b/docs/_build/doctrees/tools/metadata.doctree index d328fb177..d22b4ebae 100644 Binary files a/docs/_build/doctrees/tools/metadata.doctree and b/docs/_build/doctrees/tools/metadata.doctree differ diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js index 9c132e9f3..f4b51a79b 100644 --- a/docs/_build/html/searchindex.js +++ b/docs/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["auth","file","index","indexing","jobs","metadata","submission","tools","tools/indexing","tools/metadata"],envversion:53,filenames:["auth.rst","file.rst","index.rst","indexing.rst","jobs.rst","metadata.rst","submission.rst","tools.rst","tools/indexing.rst","tools/metadata.rst"],objects:{"gen3.auth":{Gen3Auth:[0,0,1,""]},"gen3.file":{Gen3File:[1,0,1,""]},"gen3.file.Gen3File":{get_presigned_url:[1,1,1,""]},"gen3.index":{Gen3Index:[3,0,1,""]},"gen3.index.Gen3Index":{async_create_record:[3,1,1,""],async_get_record:[3,1,1,""],async_get_records_on_page:[3,1,1,""],async_get_with_params:[3,1,1,""],async_query_urls:[3,1,1,""],async_update_record:[3,1,1,""],create_blank:[3,1,1,""],create_new_version:[3,1,1,""],create_record:[3,1,1,""],delete_record:[3,1,1,""],get:[3,1,1,""],get_all_records:[3,1,1,""],get_latest_version:[3,1,1,""],get_record:[3,1,1,""],get_record_doc:[3,1,1,""],get_records:[3,1,1,""],get_records_on_page:[3,1,1,""],get_stats:[3,1,1,""],get_urls:[3,1,1,""],get_version:[3,1,1,""],get_versions:[3,1,1,""],get_with_params:[3,1,1,""],is_healthy:[3,1,1,""],query_urls:[3,1,1,""],update_blank:[3,1,1,""],update_record:[3,1,1,""]},"gen3.jobs":{Gen3Jobs:[4,0,1,""]},"gen3.jobs.Gen3Jobs":{async_run_job_and_wait:[4,1,1,""],create_job:[4,1,1,""],get_output:[4,1,1,""],get_status:[4,1,1,""],get_version:[4,1,1,""],is_healthy:[4,1,1,""],list_jobs:[4,1,1,""]},"gen3.metadata":{Gen3Metadata:[5,0,1,""]},"gen3.metadata.Gen3Metadata":{"delete":[5,1,1,""],admin_endpoint:[5,2,1,""],async_create:[5,1,1,""],async_get:[5,1,1,""],async_update:[5,1,1,""],batch_create:[5,1,1,""],create:[5,1,1,""],create_index_key_path:[5,1,1,""],delete_index_key_path:[5,1,1,""],endpoint:[5,2,1,""],get:[5,1,1,""],get_index_key_paths:[5,1,1,""],get_version:[5,1,1,""],is_healthy:[5,1,1,""],query:[5,1,1,""],update:[5,1,1,""]},"gen3.submission":{Gen3Submission:[6,0,1,""]},"gen3.submission.Gen3Submission":{create_program:[6,1,1,""],create_project:[6,1,1,""],delete_program:[6,1,1,""],delete_project:[6,1,1,""],delete_record:[6,1,1,""],export_node:[6,1,1,""],export_record:[6,1,1,""],get_dictionary_all:[6,1,1,""],get_dictionary_node:[6,1,1,""],get_graphql_schema:[6,1,1,""],get_programs:[6,1,1,""],get_project_dictionary:[6,1,1,""],get_project_manifest:[6,1,1,""],get_projects:[6,1,1,""],open_project:[6,1,1,""],query:[6,1,1,""],submit_file:[6,1,1,""],submit_record:[6,1,1,""]},"gen3.tools.indexing":{download_manifest:[8,3,0,"-"],index_manifest:[8,3,0,"-"],verify_manifest:[8,3,0,"-"]},"gen3.tools.indexing.download_manifest":{CURRENT_DIR:[8,2,1,""],INDEXD_RECORD_PAGE_SIZE:[8,2,1,""],MAX_CONCURRENT_REQUESTS:[8,2,1,""],TMP_FOLDER:[8,2,1,""],async_download_object_manifest:[8,4,1,""]},"gen3.tools.indexing.index_manifest":{ACLS:[8,2,1,""],AUTHZ:[8,2,1,""],CURRENT_DIR:[8,2,1,""],GUID:[8,2,1,""],MD5:[8,2,1,""],SIZE:[8,2,1,""],ThreadControl:[8,0,1,""],URLS:[8,2,1,""],get_and_verify_fileinfos_from_manifest:[8,4,1,""],get_and_verify_fileinfos_from_tsv_manifest:[8,4,1,""],index_object_manifest:[8,4,1,""]},"gen3.tools.indexing.verify_manifest":{CURRENT_DIR:[8,2,1,""],MAX_CONCURRENT_REQUESTS:[8,2,1,""],async_verify_object_manifest:[8,4,1,""]},"gen3.tools.metadata":{ingest_manifest:[9,3,0,"-"]},"gen3.tools.metadata.ingest_manifest":{COLUMN_TO_USE_AS_GUID:[9,2,1,""],GUID_TYPE_FOR_INDEXED_FILE_OBJECT:[9,2,1,""],GUID_TYPE_FOR_NON_INDEXED_FILE_OBJECT:[9,2,1,""],MAX_CONCURRENT_REQUESTS:[9,2,1,""],async_ingest_metadata_manifest:[9,4,1,""],async_query_urls_from_indexd:[9,4,1,""]},gen3:{tools:[7,3,0,"-"]}},objnames:{"0":["py","class","Python class"],"1":["py","method","Python method"],"2":["py","attribute","Python attribute"],"3":["py","module","Python module"],"4":["py","function","Python function"]},objtypes:{"0":"py:class","1":"py:method","2":"py:attribute","3":"py:module","4":"py:function"},terms:{"0a80fada010c":8,"0a80fada096c":8,"0a80fada097c":8,"0a80fada098c":8,"0a80fada099c":8,"0x7f3ab76a59d8":9,"0x7f3ab76a5c80":9,"0x7f3ab78d4488":8,"0x7f3ab78d4510":8,"0x7f3ab78d4598":8,"0x7f3ab78d4620":8,"0x7f3ab78d46a8":8,"0x7f3ab78d4730":8,"0x7f3ab78d47b8":8,"11e9":8,"255e396f":8,"450c":8,"473d83400bc1bc9dc635e334fadd433c":8,"473d83400bc1bc9dc635e334faddd33c":8,"473d83400bc1bc9dc635e334fadde33c":8,"473d83400bc1bc9dc635e334faddf33c":8,"6f90":6,"7d3d8d2083b4":8,"93d9af72":8,"9a07":8,"boolean":3,"class":[0,2,8],"default":8,"export":6,"function":[2,3,4,5,7,8,9],"import":8,"int":[3,5,6,8,9],"new":3,"public":5,"return":[3,4,5,6,8],"true":[3,4,5,8,9],"while":[0,1,3,4,5,6],But:5,For:[1,5,6,7,8],NOT:9,Such:7,That:3,The:[0,1,2,3,5,6,8],There:8,These:7,Used:8,Will:4,_get_acl_from_row:8,_get_authz_from_row:8,_get_file_name_from_row:8,_get_file_size_from_row:8,_get_guid_for_row:9,_get_guid_from_row:8,_get_md5_from_row:8,_get_urls_from_row:8,_query_for_associated_indexd_record_guid:9,_ssl:[3,4,5],a5c6:8,ab167e49d25b488939b1ede42752458b:3,about:[2,3],abov:8,access:[0,1,3],acl:[3,8],across:8,action:[7,8],actual:8,add:[3,5],added:3,addit:3,admin:[5,8],admin_endpoint:5,admin_endpoint_suffix:5,against:[3,6,8,9],algorithm:3,alia:3,all:[3,4,5,6,8,9],allow:[6,8,9],along:2,alreadi:7,altern:8,alwai:5,ammount:9,amount:7,ani:[5,8],anoth:5,api:[5,6,8],api_kei:8,arrai:6,assign:7,associ:[3,5],assum:8,async:7,async_cr:5,async_create_record:3,async_download_object_manifest:8,async_get:5,async_get_record:3,async_get_records_on_pag:3,async_get_with_param:3,async_ingest_metadata_manifest:9,async_query_url:3,async_query_urls_from_indexd:9,async_run_job_and_wait:4,async_upd:5,async_update_record:3,async_verify_object_manifest:8,asynchron:[3,4,5],asyncio:[8,9],attach:[3,5],attribut:8,auth:[1,2,3,4,5,6,8,9],auth_provid:[1,3,4,5,6],authbas:0,authent:0,authz:[3,8],auto:2,automat:0,avail:[1,2],b0f1:8,base:[0,1,3,4,5,6,7,8],baseid:3,basic:[3,8,9],batch_creat:5,behavior:8,belong:6,below:8,blank:3,blob:5,bodi:3,bool:[4,5,8,9],broad:7,broken:7,can:[0,3,4,6,8,9],capabl:7,categori:7,ccle:6,ccle_one_record:6,ccle_sample_nod:6,chang:[3,8],chunk_siz:6,client:3,code:[2,6],column:[8,9],column_to_use_as_guid:9,comma:8,common:[0,1,3,4,5,6,7,8,9],commons_url:[8,9],complet:4,concat:8,concurr:[8,9],connect:9,consist:3,contain:[0,2,5,6,7,8,9],content:3,control:3,coroutin:8,correspond:3,crdc:[0,1,3,4,5,6],creat:[3,4,5,6,8],create_blank:3,create_index_key_path:5,create_job:4,create_new_vers:3,create_program:6,create_project:6,create_record:3,credenti:[0,1,3,4,5,6,8],csv:[6,8,9],current:6,current_dir:8,custom:8,d70b41b9:6,data:[0,1,3,5,6],data_spreadsheet:6,databas:5,datacommon:[0,1,3,4,5,6],dbgap:9,dcf:6,def:8,defin:[5,6],delai:4,delet:[3,5,6],delete_index_key_path:5,delete_program:6,delete_project:6,delete_record:[3,6],delimet:[8,9],delimit:8,demo:[0,1,3,4,5,6],descript:5,desir:8,detail:2,determin:[8,9],dev:8,dict:[3,4,5,8,9],dictionari:[3,4,5,6],did:3,differ:5,directori:8,dispatch:4,dist_resolut:3,distribut:3,docstr:2,document:3,doe:9,domain:[8,9],done:4,download:[0,1,2,3,4,5,6,7],download_manifest:8,e043ab8b77b9:6,each:[3,6,8],effici:7,either:6,elsewher:9,empti:6,end:5,endpoint:[0,1,3,4,5,6],entir:6,entri:3,error:[8,9],error_nam:8,etc:6,everi:[7,8],exampl:[0,1,3,4,5,6,8],exclud:3,execut:6,exist:[3,5,7,9],expect:[5,7,8],expir:0,export_nod:6,export_record:6,extent:8,f1f8:8,fail:6,fals:[3,5,8],featur:1,field:[3,5,8],fieldnam:8,file:[0,2,3,4,6,7,8,9],file_nam:[3,8],file_s:8,file_st:3,fileformat:6,filenam:[6,8,9],filter:5,first:6,flag:8,folder:8,follow:[0,8],format:[3,5,6,8],from:[0,1,2,3,4,5,6,7,8,9],func_to_parse_row:[8,9],gen3:[8,9],gen3auth:[0,1,3,4,5,6,8,9],gen3fil:1,gen3index:3,gen3job:4,gen3metadata:5,gen3submiss:[3,6],gener:[0,1,2,3,4,5,6],get:[1,3,4,5,6,8,9],get_all_record:3,get_and_verify_fileinfos_from_manifest:8,get_and_verify_fileinfos_from_tsv_manifest:8,get_dictionary_al:6,get_dictionary_nod:6,get_graphql_schema:6,get_guid_from_fil:9,get_index_key_path:5,get_latest_vers:3,get_output:4,get_presigned_url:1,get_program:6,get_project:6,get_project_dictionari:6,get_project_manifest:6,get_record:3,get_record_doc:3,get_records_on_pag:3,get_stat:3,get_statu:4,get_url:3,get_vers:[3,4,5],get_with_param:3,giangb:8,github:2,give:1,given:[3,4,5,6,9],global:4,good:3,graphql:6,group:3,guid:[1,3,5,8,9],guid_exampl:8,guid_for_row:9,guid_from_fil:9,guid_type_for_indexed_file_object:9,guid_type_for_non_indexed_file_object:9,handl:3,has:8,has_vers:3,hash:[3,8],hash_typ:3,have:[5,8],header:8,healthi:[3,4,5],help:8,helper:2,hit:8,how:8,http:[0,1,3,4,5,6,8,9],idea:3,identifi:[3,7],idp:0,ids:3,immut:3,implement:0,includ:3,include_additional_column:8,index:[2,5,7],index_manifest:8,index_object_manifest:8,indexd:[3,8,9],indexd_field:[8,9],indexd_record_page_s:8,indexed_file_object_guid:9,indic:8,info:[3,8],inform:[2,3],ingest:[2,7],ingest_manifest:9,initi:0,input:[4,8],instal:2,instanc:[1,3,6,7],integ:[3,6],interact:[1,3,4,5,6],introspect:6,involv:7,is_healthi:[3,4,5],its:3,job:2,job_id:4,job_input:4,job_nam:4,json:[0,1,3,4,5,6,8],just:[5,8,9],jwt:0,kei:[3,5],kwarg:[4,5],larg:7,latest:3,least:3,librari:8,like:[3,5,7,8,9],limit:[1,3,5,9],linear:4,list:[3,4,5,6,8],list_job:4,live:[8,9],lock:9,log:[8,9],logic:5,loop:8,made:3,mai:7,make:[7,8],manag:1,mani:8,manifest:[6,7,8,9],manifest_fil:[8,9],manifest_file_delimit:[8,9],manifest_row_pars:[8,9],map:8,mark:6,match:[3,5,9],max:5,max_concurrent_request:[8,9],max_tri:6,maximum:[8,9],md5:[3,8],md5_hash:8,mds:[5,9],mean:6,mechan:3,metadata:[2,3,7],metadata_list:5,metadata_sourc:9,metdata:9,modul:[2,8],more:[2,5,7],most:7,mostli:2,multipl:[6,8],must:5,name:[3,4,6,8,9],namespac:9,nci:[0,1,3,4,5,6],necessari:3,need:[3,8],nest:5,net:8,node:6,node_typ:6,none:[0,3,4,5,6,8,9],note:[3,8,9],noth:3,now:[1,6],num:5,num_process:8,num_total_fil:8,number:[3,6,8,9],object:[1,3,4,5,6,7,8],off:5,offset:5,old:3,one:[3,5,8],onli:[3,6],open:[6,8],open_project:6,opt:0,option:[0,1,3,4,5,6,8],order:0,output:[4,5,8,9],output_filenam:[8,9],overrid:[8,9],overwrit:5,page:[0,1,2,3,4,5,6,8],pagin:3,parallel:8,param:[3,6],paramet:[0,1,3,4,5,6,8,9],pars:[8,9],parser:[8,9],pass:6,password:[8,9],path:[5,8],path_to_manifest:8,pattern:[3,9],pdcdatastor:8,per:8,peregrin:6,persist:7,phs0001:8,phs0002:8,pick:1,pla:8,place:8,planx:8,point:[0,1,3,4,5,6],popul:9,post:8,presign:1,previou:3,previous:4,print:6,process:8,processed_fil:8,profil:[0,1,3,4,5,6],program:[6,8],project:[6,8],project_id:6,protocol:1,provid:[0,3,5,6],python:[2,7,8],queri:[1,3,5,6,9],query_txt:6,query_url:3,quickstart:2,raw:8,rbac:3,read:5,readm:2,record:[3,5,6,8,9],refresh:0,refresh_fil:[0,1,3,4,5,6],refresh_token:0,regist:6,relat:7,replac:8,replace_url:8,repo:2,repres:[3,5],represent:3,request:[0,3,6,8,9],respons:[3,4],result:6,retri:6,retriev:[1,6,9],return_full_metadata:5,rev:3,revis:3,right:1,root:[8,9],row:[6,8,9],row_offset:6,run:6,safe:8,same:[5,8],sampl:6,sandbox:[0,1,3,4,5,6],schema:6,screen:6,script:2,search:[2,3],second:4,see:8,semaphon:9,semaphor:9,separ:8,servic:[1,3,4,5,6,9],service_loc:[3,4,5],session:8,setup:2,sheepdog:6,should:[6,8],shown:8,signpost:3,simpl:3,simpli:8,sinc:3,singl:6,size:[3,8],skip:6,sleep:4,some:2,sourc:[0,1,2,3,4,5,6,8,9],space:8,specif:[5,6,8,9],specifi:[0,3],spreadsheet:6,ssl:[3,4,5],start:[3,4,6],statu:4,store:3,str:[0,1,3,4,5,6,8,9],string:[0,3,5,8],strip:8,sub:[1,3,4,5,6],subject:6,submiss:2,submit:6,submit_fil:6,submit_record:6,suffici:3,suppli:3,support:[0,1,5,6,8],synchron:8,system:[6,7],tab:8,task:7,temporari:8,test1:8,test2:8,test3:8,test4:8,test5:8,test:8,text:6,than:5,thei:0,them:8,thi:[0,1,2,3,4,5,6,8,9],those:8,thread:8,thread_num:8,threadcontrol:8,through:[6,8],time:[1,6,8],tmp_folder:8,token:0,tool:2,total:8,treat:5,tsv:[6,8,9],tupl:[8,9],type:[3,4,5,6,8,9],under:6,until:4,updat:[3,5,8],update_blank:3,update_record:3,upload:[3,6],url:[0,1,3,6,7,8,9],urls_metadata:3,usag:8,use:[0,1,3,4,5,8,9],used:[5,9],user:9,using:[0,1,3,4,5,6,8],usual:9,util:7,uuid:[3,6],valu:[3,5,8],value_from_indexd:8,value_from_manifest:8,variabl:6,variou:2,verif:8,verifi:[2,7],verify_manifest:8,verify_object_manifest:8,version:[3,4,5],wait:4,want:[3,6],web:0,what:5,when:[0,3,9],where:[3,5,8,9],whether:[3,4,5,9],which:6,whose:5,within:[2,7],without:[3,5],won:5,work:0,workaround:8,worksheet:6,workspac:0,wrapper:8,write:8,xlsx:6,you:[3,6,8]},titles:["Gen3 Auth Helper","Gen3 File Class","Welcome to Gen3 SDK\u2019s documentation!","Gen3 Index Class","Gen3 Jobs Class","Gen3 Metadata Class","Gen3 Submission Class","Gen3 Tools","Indexing Tools","Metadata Tools"],titleterms:{"class":[1,3,4,5,6],auth:0,document:2,download:8,file:1,gen3:[0,1,2,3,4,5,6,7],helper:0,index:[3,8],indic:2,ingest:9,job:4,metadata:[5,9],sdk:2,submiss:6,tabl:2,tool:[7,8,9],verifi:8,welcom:2}}) \ No newline at end of file +Search.setIndex({docnames:["auth","file","index","indexing","jobs","metadata","submission","tools","tools/indexing","tools/metadata"],envversion:53,filenames:["auth.rst","file.rst","index.rst","indexing.rst","jobs.rst","metadata.rst","submission.rst","tools.rst","tools/indexing.rst","tools/metadata.rst"],objects:{"gen3.auth":{Gen3Auth:[0,0,1,""]},"gen3.file":{Gen3File:[1,0,1,""]},"gen3.file.Gen3File":{get_presigned_url:[1,1,1,""]},"gen3.index":{Gen3Index:[3,0,1,""]},"gen3.index.Gen3Index":{async_create_record:[3,1,1,""],async_get_record:[3,1,1,""],async_get_records_on_page:[3,1,1,""],async_get_with_params:[3,1,1,""],async_query_urls:[3,1,1,""],async_update_record:[3,1,1,""],create_blank:[3,1,1,""],create_new_version:[3,1,1,""],create_record:[3,1,1,""],delete_record:[3,1,1,""],get:[3,1,1,""],get_all_records:[3,1,1,""],get_latest_version:[3,1,1,""],get_record:[3,1,1,""],get_record_doc:[3,1,1,""],get_records:[3,1,1,""],get_records_on_page:[3,1,1,""],get_stats:[3,1,1,""],get_urls:[3,1,1,""],get_version:[3,1,1,""],get_versions:[3,1,1,""],get_with_params:[3,1,1,""],is_healthy:[3,1,1,""],query_urls:[3,1,1,""],update_blank:[3,1,1,""],update_record:[3,1,1,""]},"gen3.jobs":{Gen3Jobs:[4,0,1,""]},"gen3.jobs.Gen3Jobs":{async_run_job_and_wait:[4,1,1,""],create_job:[4,1,1,""],get_output:[4,1,1,""],get_status:[4,1,1,""],get_version:[4,1,1,""],is_healthy:[4,1,1,""],list_jobs:[4,1,1,""]},"gen3.metadata":{Gen3Metadata:[5,0,1,""]},"gen3.metadata.Gen3Metadata":{"delete":[5,1,1,""],admin_endpoint:[5,2,1,""],async_create:[5,1,1,""],async_get:[5,1,1,""],async_update:[5,1,1,""],batch_create:[5,1,1,""],create:[5,1,1,""],create_index_key_path:[5,1,1,""],delete_index_key_path:[5,1,1,""],endpoint:[5,2,1,""],get:[5,1,1,""],get_index_key_paths:[5,1,1,""],get_version:[5,1,1,""],is_healthy:[5,1,1,""],query:[5,1,1,""],update:[5,1,1,""]},"gen3.submission":{Gen3Submission:[6,0,1,""]},"gen3.submission.Gen3Submission":{create_program:[6,1,1,""],create_project:[6,1,1,""],delete_program:[6,1,1,""],delete_project:[6,1,1,""],delete_record:[6,1,1,""],export_node:[6,1,1,""],export_record:[6,1,1,""],get_dictionary_all:[6,1,1,""],get_dictionary_node:[6,1,1,""],get_graphql_schema:[6,1,1,""],get_programs:[6,1,1,""],get_project_dictionary:[6,1,1,""],get_project_manifest:[6,1,1,""],get_projects:[6,1,1,""],open_project:[6,1,1,""],query:[6,1,1,""],submit_file:[6,1,1,""],submit_record:[6,1,1,""]},"gen3.tools.indexing":{download_manifest:[8,3,0,"-"],index_manifest:[8,3,0,"-"],verify_manifest:[8,3,0,"-"]},"gen3.tools.indexing.download_manifest":{CURRENT_DIR:[8,2,1,""],INDEXD_RECORD_PAGE_SIZE:[8,2,1,""],MAX_CONCURRENT_REQUESTS:[8,2,1,""],TMP_FOLDER:[8,2,1,""],async_download_object_manifest:[8,4,1,""]},"gen3.tools.indexing.index_manifest":{ACLS:[8,2,1,""],AUTHZ:[8,2,1,""],CURRENT_DIR:[8,2,1,""],GUID:[8,2,1,""],MD5:[8,2,1,""],SIZE:[8,2,1,""],ThreadControl:[8,0,1,""],URLS:[8,2,1,""],get_and_verify_fileinfos_from_manifest:[8,4,1,""],get_and_verify_fileinfos_from_tsv_manifest:[8,4,1,""],index_object_manifest:[8,4,1,""]},"gen3.tools.indexing.verify_manifest":{CURRENT_DIR:[8,2,1,""],MAX_CONCURRENT_REQUESTS:[8,2,1,""],async_verify_object_manifest:[8,4,1,""]},"gen3.tools.metadata":{ingest_manifest:[9,3,0,"-"]},"gen3.tools.metadata.ingest_manifest":{COLUMN_TO_USE_AS_GUID:[9,2,1,""],GUID_TYPE_FOR_INDEXED_FILE_OBJECT:[9,2,1,""],GUID_TYPE_FOR_NON_INDEXED_FILE_OBJECT:[9,2,1,""],MAX_CONCURRENT_REQUESTS:[9,2,1,""],async_ingest_metadata_manifest:[9,4,1,""],async_query_urls_from_indexd:[9,4,1,""]},gen3:{tools:[7,3,0,"-"]}},objnames:{"0":["py","class","Python class"],"1":["py","method","Python method"],"2":["py","attribute","Python attribute"],"3":["py","module","Python module"],"4":["py","function","Python function"]},objtypes:{"0":"py:class","1":"py:method","2":"py:attribute","3":"py:module","4":"py:function"},terms:{"0a80fada010c":8,"0a80fada096c":8,"0a80fada097c":8,"0a80fada098c":8,"0a80fada099c":8,"0x7f3ab76a59d8":[],"0x7f3ab76a5c80":[],"0x7f3ab78d4488":[],"0x7f3ab78d4510":[],"0x7f3ab78d4598":[],"0x7f3ab78d4620":[],"0x7f3ab78d46a8":[],"0x7f3ab78d4730":[],"0x7f3ab78d47b8":[],"0x7fa66935bb70":9,"0x7fa66935bc80":9,"0x7fa6695a2620":8,"0x7fa6695a26a8":8,"0x7fa6695a2730":8,"0x7fa6695a27b8":8,"0x7fa6695a2840":8,"0x7fa6695a28c8":8,"0x7fa6695a2950":8,"11e9":8,"255e396f":8,"450c":8,"473d83400bc1bc9dc635e334fadd433c":8,"473d83400bc1bc9dc635e334faddd33c":8,"473d83400bc1bc9dc635e334fadde33c":8,"473d83400bc1bc9dc635e334faddf33c":8,"6f90":6,"7d3d8d2083b4":8,"93d9af72":8,"9a07":8,"boolean":3,"class":[0,2,8],"default":8,"export":6,"function":[2,3,4,5,7,8,9],"import":8,"int":[3,5,6,8,9],"new":3,"public":5,"return":[3,4,5,6,8],"true":[3,4,5,8,9],"while":[0,1,3,4,5,6],But:5,For:[1,5,6,7,8],NOT:9,Such:7,That:3,The:[0,1,2,3,5,6,8],There:8,These:7,Used:8,Will:4,_get_acl_from_row:8,_get_authz_from_row:8,_get_file_name_from_row:8,_get_file_size_from_row:8,_get_guid_for_row:9,_get_guid_from_row:8,_get_md5_from_row:8,_get_urls_from_row:8,_query_for_associated_indexd_record_guid:9,_ssl:[3,4,5],a5c6:8,ab167e49d25b488939b1ede42752458b:3,about:[2,3],abov:8,access:[0,1,3],acl:[3,8],across:8,action:[7,8],actual:8,add:[3,5],added:3,addit:3,admin:[5,8],admin_endpoint:5,admin_endpoint_suffix:5,against:[3,6,8,9],algorithm:3,alia:3,all:[3,4,5,6,8,9],allow:[6,8,9],along:2,alreadi:7,altern:8,alwai:5,ammount:9,amount:7,ani:[5,8],anoth:5,api:[5,6,8],api_kei:8,arrai:6,assign:7,associ:[3,5],assum:8,async:7,async_cr:5,async_create_record:3,async_download_object_manifest:8,async_get:5,async_get_record:3,async_get_records_on_pag:3,async_get_with_param:3,async_ingest_metadata_manifest:9,async_query_url:3,async_query_urls_from_indexd:9,async_run_job_and_wait:4,async_upd:5,async_update_record:3,async_verify_object_manifest:8,asynchron:[3,4,5],asyncio:[8,9],attach:[3,5],attribut:8,auth:[1,2,3,4,5,6,8,9],auth_provid:[1,3,4,5,6],authbas:0,authent:0,authz:[3,8],auto:2,automat:0,avail:[1,2],b0f1:8,base:[0,1,3,4,5,6,7,8],baseid:3,basic:[3,8,9],batch_creat:5,behavior:8,belong:6,below:8,blank:3,blob:5,bodi:3,bool:[4,5,8,9],broad:7,broken:7,can:[0,3,4,6,8,9],capabl:7,categori:7,ccle:6,ccle_one_record:6,ccle_sample_nod:6,chang:[3,8],chunk_siz:6,client:3,code:[2,6],column:[8,9],column_to_use_as_guid:9,comma:8,common:[0,1,3,4,5,6,7,8,9],commons_url:[8,9],complet:4,concat:8,concurr:[8,9],connect:9,consist:3,contain:[0,2,5,6,7,8,9],content:3,control:3,coroutin:8,correspond:3,crdc:[0,1,3,4,5,6],creat:[3,4,5,6,8],create_blank:3,create_index_key_path:5,create_job:4,create_new_vers:3,create_program:6,create_project:6,create_record:3,credenti:[0,1,3,4,5,6,8],csv:[6,8,9],current:6,current_dir:8,custom:8,d70b41b9:6,data:[0,1,3,5,6],data_spreadsheet:6,databas:5,datacommon:[0,1,3,4,5,6],dbgap:9,dcf:6,def:8,defin:[5,6],delai:4,delet:[3,5,6],delete_index_key_path:5,delete_program:6,delete_project:6,delete_record:[3,6],delimet:[8,9],delimit:8,demo:[0,1,3,4,5,6],descript:5,desir:8,detail:2,determin:[8,9],dev:8,dict:[3,4,5,8,9],dictionari:[3,4,5,6],did:3,differ:5,directori:8,dispatch:4,dist_resolut:3,distribut:3,docstr:2,document:3,doe:9,domain:[8,9],done:4,download:[0,1,2,3,4,5,6,7],download_manifest:8,e043ab8b77b9:6,each:[3,6,8],effici:7,either:6,elsewher:9,empti:6,end:5,endpoint:[0,1,3,4,5,6],entir:6,entri:3,error:[8,9],error_nam:8,etc:6,everi:[7,8],exampl:[0,1,3,4,5,6,8],exclud:3,execut:6,exist:[3,5,7,9],expect:[5,7,8],expir:0,export_nod:6,export_record:6,extent:8,f1f8:8,fail:6,fals:[3,5,8],featur:1,field:[3,5,8],fieldnam:8,file:[0,2,3,4,6,7,8,9],file_nam:[3,8],file_s:8,file_st:3,fileformat:6,filenam:[6,8,9],filter:5,first:6,flag:8,folder:8,follow:[0,8],format:[3,5,6,8],from:[0,1,2,3,4,5,6,7,8,9],func_to_parse_row:[8,9],gen3:[8,9],gen3auth:[0,1,3,4,5,6,8,9],gen3fil:1,gen3index:3,gen3job:4,gen3metadata:5,gen3submiss:[3,6],gener:[0,1,2,3,4,5,6],get:[1,3,4,5,6,8,9],get_all_record:3,get_and_verify_fileinfos_from_manifest:8,get_and_verify_fileinfos_from_tsv_manifest:8,get_dictionary_al:6,get_dictionary_nod:6,get_graphql_schema:6,get_guid_from_fil:9,get_index_key_path:5,get_latest_vers:3,get_output:4,get_presigned_url:1,get_program:6,get_project:6,get_project_dictionari:6,get_project_manifest:6,get_record:3,get_record_doc:3,get_records_on_pag:3,get_stat:3,get_statu:4,get_url:3,get_vers:[3,4,5],get_with_param:3,giangb:8,github:2,give:1,given:[3,4,5,6,9],global:4,good:3,graphql:6,group:3,guid:[1,3,5,8,9],guid_exampl:8,guid_for_row:9,guid_from_fil:9,guid_type_for_indexed_file_object:9,guid_type_for_non_indexed_file_object:9,handl:3,has:8,has_vers:3,hash:[3,8],hash_typ:3,have:[5,8],header:8,healthi:[3,4,5],help:8,helper:2,hit:8,how:8,http:[0,1,3,4,5,6,8,9],idea:3,identifi:[3,7],idp:0,ids:3,immut:3,implement:0,includ:3,include_additional_column:8,index:[2,5,7],index_manifest:8,index_object_manifest:8,indexd:[3,8,9],indexd_field:[8,9],indexd_record_page_s:8,indexed_file_object_guid:9,indic:8,info:[3,8],inform:[2,3],ingest:[2,7],ingest_manifest:9,initi:0,input:[4,8],instal:2,instanc:[1,3,6,7],integ:[3,6],interact:[1,3,4,5,6],introspect:6,involv:7,is_healthi:[3,4,5],its:3,job:2,job_id:4,job_input:4,job_nam:4,json:[0,1,3,4,5,6,8],just:[5,8,9],jwt:0,kei:[3,5],kwarg:[4,5],larg:7,latest:3,least:3,librari:8,like:[3,5,7,8,9],limit:[1,3,5,9],linear:4,list:[3,4,5,6,8],list_job:4,live:[8,9],lock:9,log:[8,9],logic:5,loop:8,made:3,mai:7,make:[7,8],manag:1,mani:8,manifest:[6,7,8,9],manifest_fil:[8,9],manifest_file_delimit:[8,9],manifest_row_pars:[8,9],map:8,mark:6,match:[3,5,9],max:5,max_concurrent_request:[8,9],max_tri:6,maximum:[8,9],md5:[3,8],md5_hash:8,mds:[5,9],mean:6,mechan:3,metadata:[2,3,7],metadata_list:5,metadata_sourc:9,metdata:9,modul:[2,8],more:[2,5,7],most:7,mostli:2,multipl:[6,8],must:5,name:[3,4,6,8,9],namespac:9,nci:[0,1,3,4,5,6],necessari:3,need:[3,8],nest:5,net:8,node:6,node_typ:6,none:[0,3,4,5,6,8,9],note:[3,8,9],noth:3,now:[1,6],num:5,num_process:8,num_total_fil:8,number:[3,6,8,9],object:[1,3,4,5,6,7,8],off:5,offset:5,old:3,one:[3,5,8],onli:[3,6],open:[6,8],open_project:6,opt:0,option:[0,1,3,4,5,6,8],order:0,output:[4,5,8,9],output_filenam:[8,9],overrid:[8,9],overwrit:5,page:[0,1,2,3,4,5,6,8],pagin:3,parallel:8,param:[3,6],paramet:[0,1,3,4,5,6,8,9],pars:[8,9],parser:[8,9],pass:6,password:[8,9],path:[5,8],path_to_manifest:8,pattern:[3,9],pdcdatastor:8,per:8,peregrin:6,persist:7,phs0001:8,phs0002:8,pick:1,pla:8,place:8,planx:8,point:[0,1,3,4,5,6],popul:9,post:8,presign:1,previou:3,previous:4,print:6,process:8,processed_fil:8,profil:[0,1,3,4,5,6],program:[6,8],project:[6,8],project_id:6,protocol:1,provid:[0,3,5,6],python:[2,7,8],queri:[1,3,5,6,9],query_txt:6,query_url:3,quickstart:2,raw:8,rbac:3,read:5,readm:2,record:[3,5,6,8,9],refresh:0,refresh_fil:[0,1,3,4,5,6],refresh_token:0,regist:6,relat:7,replac:8,replace_url:8,repo:2,repres:[3,5],represent:3,request:[0,3,6,8,9],respons:[3,4],result:6,retri:6,retriev:[1,6,9],return_full_metadata:5,rev:3,revis:3,right:1,root:[8,9],row:[6,8,9],row_offset:6,run:6,safe:8,same:[5,8],sampl:6,sandbox:[0,1,3,4,5,6],schema:6,screen:6,script:2,search:[2,3],second:4,see:8,semaphon:9,semaphor:9,separ:8,servic:[1,3,4,5,6,9],service_loc:[3,4,5],session:8,setup:2,sheepdog:6,should:[6,8],shown:8,signpost:3,simpl:3,simpli:8,sinc:3,singl:6,size:[3,8],skip:6,sleep:4,some:2,sourc:[0,1,2,3,4,5,6,8,9],space:8,specif:[5,6,8,9],specifi:[0,3],spreadsheet:6,ssl:[3,4,5],start:[3,4,6],statu:4,store:3,str:[0,1,3,4,5,6,8,9],string:[0,3,5,8],strip:8,sub:[1,3,4,5,6],subject:6,submiss:2,submit:6,submit_fil:6,submit_record:6,suffici:3,suppli:3,support:[0,1,5,6,8],synchron:8,system:[6,7],tab:8,task:7,temporari:8,test1:8,test2:8,test3:8,test4:8,test5:8,test:8,text:6,than:5,thei:0,them:8,thi:[0,1,2,3,4,5,6,8,9],those:8,thread:8,thread_num:8,threadcontrol:8,through:[6,8],time:[1,6,8],tmp_folder:8,token:0,tool:2,total:8,treat:5,tsv:[6,8,9],tupl:[8,9],type:[3,4,5,6,8,9],under:6,until:4,updat:[3,5,8],update_blank:3,update_record:3,upload:[3,6],url:[0,1,3,6,7,8,9],urls_metadata:3,usag:8,use:[0,1,3,4,5,8,9],used:[5,9],user:9,using:[0,1,3,4,5,6,8],usual:9,util:7,uuid:[3,6],valu:[3,5,8],value_from_indexd:8,value_from_manifest:8,variabl:6,variou:2,verif:8,verifi:[2,7],verify_manifest:8,verify_object_manifest:8,version:[3,4,5],wait:4,want:[3,6],web:0,what:5,when:[0,3,9],where:[3,5,8,9],whether:[3,4,5,9],which:6,whose:5,within:[2,7],without:[3,5],won:5,work:0,workaround:8,worksheet:6,workspac:0,wrapper:8,write:8,xlsx:6,you:[3,6,8]},titles:["Gen3 Auth Helper","Gen3 File Class","Welcome to Gen3 SDK\u2019s documentation!","Gen3 Index Class","Gen3 Jobs Class","Gen3 Metadata Class","Gen3 Submission Class","Gen3 Tools","Indexing Tools","Metadata Tools"],titleterms:{"class":[1,3,4,5,6],auth:0,document:2,download:8,file:1,gen3:[0,1,2,3,4,5,6,7],helper:0,index:[3,8],indic:2,ingest:9,job:4,metadata:[5,9],sdk:2,submiss:6,tabl:2,tool:[7,8,9],verifi:8,welcom:2}}) \ No newline at end of file diff --git a/docs/_build/html/tools/indexing.html b/docs/_build/html/tools/indexing.html index 0060901fd..0f2f1c914 100644 --- a/docs/_build/html/tools/indexing.html +++ b/docs/_build/html/tools/indexing.html @@ -308,7 +308,7 @@

Indexing Tools
-gen3.tools.indexing.verify_manifest.async_verify_object_manifest(commons_url, manifest_file, max_concurrent_requests=24, manifest_row_parsers={'acl': <function _get_acl_from_row at 0x7f3ab78d4620>, 'authz': <function _get_authz_from_row at 0x7f3ab78d46a8>, 'file_name': <function _get_file_name_from_row at 0x7f3ab78d47b8>, 'file_size': <function _get_file_size_from_row at 0x7f3ab78d4488>, 'guid': <function _get_guid_from_row at 0x7f3ab78d4598>, 'md5': <function _get_md5_from_row at 0x7f3ab78d4510>, 'urls': <function _get_urls_from_row at 0x7f3ab78d4730>}, manifest_file_delimiter=None, output_filename='verify-manifest-errors-1607727289.4852657.log')[source]
+gen3.tools.indexing.verify_manifest.async_verify_object_manifest(commons_url, manifest_file, max_concurrent_requests=24, manifest_row_parsers={'acl': <function _get_acl_from_row at 0x7fa6695a27b8>, 'authz': <function _get_authz_from_row at 0x7fa6695a2840>, 'file_name': <function _get_file_name_from_row at 0x7fa6695a2950>, 'file_size': <function _get_file_size_from_row at 0x7fa6695a2620>, 'guid': <function _get_guid_from_row at 0x7fa6695a2730>, 'md5': <function _get_md5_from_row at 0x7fa6695a26a8>, 'urls': <function _get_urls_from_row at 0x7fa6695a28c8>}, manifest_file_delimiter=None, output_filename='verify-manifest-errors-1607728605.9815593.log')[source]

Verify all file object records into a manifest csv

diff --git a/docs/_build/html/tools/metadata.html b/docs/_build/html/tools/metadata.html index 8437be5be..8c407e90c 100644 --- a/docs/_build/html/tools/metadata.html +++ b/docs/_build/html/tools/metadata.html @@ -86,7 +86,7 @@

Metadata Tools
-gen3.tools.metadata.ingest_manifest.async_ingest_metadata_manifest(commons_url, manifest_file, metadata_source, auth=None, max_concurrent_requests=24, manifest_row_parsers={'guid_for_row': <function _get_guid_for_row at 0x7f3ab76a5c80>, 'indexed_file_object_guid': <function _query_for_associated_indexd_record_guid at 0x7f3ab76a59d8>}, manifest_file_delimiter=None, output_filename='ingest-metadata-manifest-errors-1607727289.6874635.log', get_guid_from_file=True)[source]
+gen3.tools.metadata.ingest_manifest.async_ingest_metadata_manifest(commons_url, manifest_file, metadata_source, auth=None, max_concurrent_requests=24, manifest_row_parsers={'guid_for_row': <function _get_guid_for_row at 0x7fa66935bb70>, 'indexed_file_object_guid': <function _query_for_associated_indexd_record_guid at 0x7fa66935bc80>}, manifest_file_delimiter=None, output_filename='ingest-metadata-manifest-errors-1607728606.1689672.log', get_guid_from_file=True)[source]

Ingest all metadata records into a manifest csv