Search.setIndex({docnames:["_api/airflow/providers/alibaba/cloud/hooks/index","_api/airflow/providers/alibaba/cloud/hooks/oss/index","_api/airflow/providers/alibaba/cloud/index","_api/airflow/providers/alibaba/cloud/log/index","_api/airflow/providers/alibaba/cloud/log/oss_task_handler/index","_api/airflow/providers/alibaba/cloud/operators/index","_api/airflow/providers/alibaba/cloud/operators/oss/index","_api/airflow/providers/alibaba/cloud/sensors/index","_api/airflow/providers/alibaba/cloud/sensors/oss_key/index","_api/airflow/providers/alibaba/index","_api/tests/system/providers/alibaba/example_oss_bucket/index","_api/tests/system/providers/alibaba/example_oss_object/index","_api/tests/system/providers/alibaba/index","commits","connections/alibaba","index","installing-providers-from-sources","logging/index","logging/oss-task-handler","operators/index","operators/oss"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":5,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,sphinx:56},filenames:["_api/airflow/providers/alibaba/cloud/hooks/index.rst","_api/airflow/providers/alibaba/cloud/hooks/oss/index.rst","_api/airflow/providers/alibaba/cloud/index.rst","_api/airflow/providers/alibaba/cloud/log/index.rst","_api/airflow/providers/alibaba/cloud/log/oss_task_handler/index.rst","_api/airflow/providers/alibaba/cloud/operators/index.rst","_api/airflow/providers/alibaba/cloud/operators/oss/index.rst","_api/airflow/providers/alibaba/cloud/sensors/index.rst","_api/airflow/providers/alibaba/cloud/sensors/oss_key/index.rst","_api/airflow/providers/alibaba/index.rst","_api/tests/system/providers/alibaba/example_oss_bucket/index.rst","_api/tests/system/providers/alibaba/example_oss_object/index.rst","_api/tests/system/providers/alibaba/index.rst","commits.rst","connections/alibaba.rst","index.rst","installing-providers-from-sources.rst","logging/index.rst","logging/oss-task-handler.rst","operators/index.rst","operators/oss.rst"],objects:{"airflow.providers":[[9,0,0,"-","alibaba"]],"airflow.providers.alibaba":[[2,0,0,"-","cloud"]],"airflow.providers.alibaba.cloud":[[0,0,0,"-","hooks"],[3,0,0,"-","log"],[5,0,0,"-","operators"],[7,0,0,"-","sensors"]],"airflow.providers.alibaba.cloud.hooks":[[1,0,0,"-","oss"]],"airflow.providers.alibaba.cloud.hooks.oss":[[1,1,1,"","OSSHook"],[1,4,1,"","T"],[1,5,1,"","provide_bucket_name"],[1,5,1,"","unify_bucket_name_and_key"]],"airflow.providers.alibaba.cloud.hooks.oss.OSSHook":[[1,2,1,"","append_string"],[1,3,1,"","conn_name_attr"],[1,3,1,"","conn_type"],[1,2,1,"","create_bucket"],[1,3,1,"","default_conn_name"],[1,2,1,"","delete_bucket"],[1,2,1,"","delete_object"],[1,2,1,"","delete_objects"],[1,2,1,"","download_file"],[1,2,1,"","get_bucket"],[1,2,1,"","get_conn"],[1,2,1,"","get_credential"],[1,2,1,"","get_default_region"],[1,2,1,"","head_key"],[1,3,1,"","hook_name"],[1,2,1,"","key_exist"],[1,2,1,"","load_string"],[1,2,1,"","object_exists"],[1,2,1,"","parse_oss_url"],[1,2,1,"","read_key"],[1,2,1,"","upload_local_file"]],"airflow.providers.alibaba.cloud.log":[[4,0,0,"-","oss_task_handler"]],"airflow.providers.alibaba.cloud.log.oss_task_handler":[[4,1,1,"","OSSTaskHandler"]],"airflow.providers.alibaba.cloud.log.oss_task_handler.OSSTaskHandler":[[4,2,1,"","close"],[4,2,1,"","hook"],[4,2,1,"","oss_log_exists"],[4,2,1,"","oss_read"],[4,2,1,"","oss_write"],[4,2,1,"","set_context"]],"airflow.providers.alibaba.cloud.operators":[[6,0,0,"-","oss"]],"airflow.providers.alibaba.cloud.operators.oss":[[6,1,1,"","OSSCreateBucketOperator"],[6,1,1,"","OSSDeleteBatchObjectOperator"],[6,1,1,"","OSSDeleteBucketOperator"],[6,1,1,"","OSSDeleteObjectOperator"],[6,1,1,"","OSSDownloadObjectOperator"],[6,1,1,"","OSSUploadObjectOperator"]],"airflow.providers.alibaba.cloud.operators.oss.OSSCreateBucketOperator":[[6,2,1,"","execute"]],"airflow.providers.alibaba.cloud.operators.oss.OSSDeleteBatchObjectOperator":[[6,2,1,"","execute"]],"airflow.providers.alibaba.cloud.operators.oss.OSSDeleteBucketOperator":[[6,2,1,"","execute"]],"airflow.providers.alibaba.cloud.operators.oss.OSSDeleteObjectOperator":[[6,2,1,"","execute"]],"airflow.providers.alibaba.cloud.operators.oss.OSSDownloadObjectOperator":[[6,2,1,"","execute"]],"airflow.providers.alibaba.cloud.operators.oss.OSSUploadObjectOperator":[[6,2,1,"","execute"]],"airflow.providers.alibaba.cloud.sensors":[[8,0,0,"-","oss_key"]],"airflow.providers.alibaba.cloud.sensors.oss_key":[[8,1,1,"","OSSKeySensor"]],"airflow.providers.alibaba.cloud.sensors.oss_key.OSSKeySensor":[[8,2,1,"","get_hook"],[8,2,1,"","poke"],[8,3,1,"","template_fields"]],"tests.system.providers":[[12,0,0,"-","alibaba"]],"tests.system.providers.alibaba":[[10,0,0,"-","example_oss_bucket"],[11,0,0,"-","example_oss_object"]],"tests.system.providers.alibaba.example_oss_bucket":[[10,4,1,"","DAG_ID"],[10,4,1,"","ENV_ID"],[10,4,1,"","create_bucket"],[10,4,1,"","test_run"]],"tests.system.providers.alibaba.example_oss_object":[[11,4,1,"","DAG_ID"],[11,4,1,"","ENV_ID"],[11,4,1,"","create_object"],[11,4,1,"","test_run"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"],"4":["py","data","Python data"],"5":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute","4":"py:data","5":"py:function"},terms:{"0":[0,1,2,3,4,5,6,7,8,9,10,11,12,14,16,17,18,19,20],"01":13,"02":13,"027b707d21":13,"03":13,"05":13,"06":13,"07":13,"08":13,"09":13,"0fe0b06bb0":13,"1":20,"10":[13,15],"11":[13,16],"12":[13,16],"13":13,"14":[13,15],"15":13,"16adc035b1":13,"17200":13,"17201":13,"17682":13,"18":13,"18019":13,"18597":13,"18613":13,"19":13,"19099":13,"19321":13,"19882":13,"2":[0,1,2,3,4,5,6,7,8,9,10,11,12,14,16,17,18,19,20],"20":13,"2021":[13,16,20],"2022":13,"20226":13,"20393":13,"20423":13,"20523":13,"20556":13,"20565":13,"20571":13,"20614":13,"20827":13,"20936":13,"20951":13,"21":13,"21014":13,"21257":13,"21439":13,"21785":[13,15],"22":13,"22056":13,"22226":13,"22382":15,"22383":13,"22437":13,"23":13,"23891":[13,15],"24130":13,"24153":[13,15],"24229":13,"24231":13,"24292":13,"29":13,"2fb5e1d0ec":13,"3":15,"30":13,"31":13,"3299064958":13,"4":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20],"406f":16,"49":16,"4d3a":16,"512":16,"54":16,"5c6e":16,"602abe8394":13,"6674":16,"6c3a67d4fc":13,"717a7588bc":13,"730db3fb77":13,"73ab0edce5":13,"73c0d241d8":13,"75ca6543da":13,"76ed2a49c6":13,"7bd8b2d7f3":13,"840ea3efb9":13,"853576d901":13,"8ec4":16,"97496ba2b4":13,"case":1,"class":15,"default":13,"do":16,"function":4,"import":[13,16,20],"int":1,"new":[4,13,20],"return":[1,4,8],"static":[1,13],"true":[1,4,8,18],"try":18,By:16,For:[13,16],If:[4,16,18],In:[18,20],It:[4,16],The:[1,6,8,14,16],There:16,To:[16,18],a0821235fb:13,about:[13,16],abov:[16,18],access:[14,18],access_key_id:14,access_key_secret:14,ad:[13,15],add:[13,15],aeabe994b3:13,airflow:[16,18,20],ak:14,aka:16,alibaba:[16,17],alibabacloud_conn_id:1,all:[13,14,15],alreadi:16,also:16,an:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20],ani:[4,16],apach:16,apache_airflow_providers_alibaba:16,api:[1,15],append:[1,4],append_str:1,appli:[13,15],ar:[4,13,14,15,16],arg:[1,13],asc:16,auth:14,auth_typ:14,autoapi:13,avail:[15,16],b5d520cf73:13,ba4b:16,base:[1,4,6,8],base_log_fold:4,basehook:1,baseoper:6,basesensoroper:8,bash:16,be75dcd39c:13,been:1,being:8,belong:16,below:[15,16],bin:16,binari:16,blob:15,bool:1,bst:16,bucket:[1,6,8,13,14,15,18],bucket_kei:8,bucket_nam:[1,6,8,20],bugfix:13,build:16,c23826915d:13,c887275bb8:13,cached_properti:13,can:[14,15,16,18],catchup:20,cde15c6e4d3a8ec4ecf4ba4b6674e08ad7de406f:16,cde1:16,certif:16,certifi:16,cfg:18,chang:13,changelog:13,chapter:16,check:[1,4,8,16],checksum:16,choos:16,classifi:[13,15],cleanup:13,close:4,cloud:[9,13,15],code:[16,20],com:[15,16],commit:13,compat:13,concaten:13,configur:18,conn_name_attr:1,conn_typ:1,connect:[1,6,8,13,15,18],contain:[6,16],context:[4,6,8,13],contributor:13,correct:16,creat:[1,4,6,8,16],create_bucket:[1,10,20],create_object:11,credenti:[6,8],curl:16,d19cb86660:13,d56e7b56bb:13,d7dbfb7e26:13,d7de:16,d94fa37830:13,d9567eb106:13,d:16,dag:[13,15,20],dag_id:[10,11,20],data:13,datetim:20,decemb:13,declar:13,decor:1,default_arg:[13,20],default_conn_nam:1,delai:13,delet:[1,6],delete_bucket:[1,20],delete_object:1,dep:16,deriv:6,describ:16,descript:13,design:13,dest:16,detail:[13,15,16],dev0:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20],dictionari:[6,14],diff:16,differ:16,directori:[13,16],distribut:16,doc:13,docstr:[13,15],document:13,doe:8,don:18,doubl:13,down:16,download:[1,6,16],download_fil:1,drop:16,e08a:16,ecf4:16,echo:16,ef037e7021:13,either:18,els:4,enabl:[13,15],env_id:[10,11],error:[4,13],essenti:16,everywher:13,exampl:[13,15,16,18,20],example_dag:13,example_oss_bucket:[12,20],example_oss_object:12,execut:6,exist:[1,4,8,15,18],experiment:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20],explain:[13,15],explanatori:13,extend:4,f5ad26dcdd:13,f5b96315fe:13,f77417eb0d:13,f8fd0f7b4c:13,fail:[4,18],failur:20,fake:13,fals:[1,4,8,20],featur:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,16,17,18,19,20],feb:13,few:13,file:[1,4,6,8,13,16],file_task_handl:4,filename_templ:4,filetaskhandl:4,find:1,fingerprint:16,fix:13,fixup:13,folder:[8,16],follow:[14,16,18,20],found:4,foundat:16,framework:15,friendli:13,from:[1,4,8,15,20],full:8,func:1,get:[1,16],get_bucket:1,get_conn:1,get_credenti:1,get_default_region:1,get_hook:8,get_template_context:6,github:15,given:20,gmail:16,good:16,gpg:16,guid:16,gz:16,ha:1,handl:4,handler:[4,13,15],have:[13,18],head_kei:1,high:13,hook:[2,4,9,13,14],hook_nam:1,how:16,http:[15,16],i:16,id:[16,18],includ:[13,15],indic:16,individu:13,info:1,inform:13,init:13,initi:15,install_requir:15,instanc:[4,8],instruct:16,integr:[13,15,20],interact:[1,20],introduc:13,isort:13,issuer:16,itself:8,januari:13,jinja:6,json:14,just:8,k8:13,ka:16,kaxil:16,kaxilnaik:16,kei:[1,6,8,14,16],key_exist:1,know:16,kwarg:[1,6,8],l:16,la:16,latest:13,lazili:13,least:1,leav:8,left:16,level:[8,13],librari:1,light:[13,15],like:[1,6,8],line:13,link:16,list:[1,6,13,15,20],load:1,load_str:1,local:[1,4,6,16],local_fil:[1,6],locat:[4,18],log:[2,9,13,15],logging_mixin:4,loggingmixin:4,logic:[13,15],ls:16,made:16,mai:[13,14],main:[6,15,16],manag:[13,16],march:13,mark:20,match:16,max_active_run:20,md:15,messag:4,meta:[1,13],method:6,migrat:13,min:13,minimum:15,mirror:16,misc:13,miss:13,mistakenli:15,mktemp:16,model:6,more:6,most:16,must:18,my:18,mypi:13,naik:16,name:[1,6,8,14,20],need:20,none:[1,4,6,8,16],note:13,novemb:13,now:[13,14],o:16,object:[1,6,8,20],object_exist:1,occur:4,octob:13,offici:16,onc:16,one:16,onli:[14,15],oper:[2,9,15],option:[1,6,8,14],order:20,org:16,origin:16,oss2:[1,15],oss:[0,2,4,5,8,9,13,14,15,17,19],oss_bucket_dag:10,oss_conn_id:[1,6,8],oss_default:[1,6,8,14,18],oss_kei:[2,7,9],oss_log_exist:4,oss_log_fold:4,oss_object_dag:11,oss_read:4,oss_task_handl:[2,3,9,13,15],oss_writ:4,osscreatebucketoper:[6,20],ossdeletebatchobjectoper:[6,20],ossdeletebucketoper:[6,20],ossdeleteobjectoper:[6,20],ossdownloadobjectoper:[6,20],osshook:[1,8,18],osskeysensor:[8,20],osstaskhandl:4,ossuploadobjectoper:[6,20],ossurl:1,otherwis:[4,8],out:1,overwritten:4,owner:16,package_nam:16,package_vers:16,page:16,param:8,paramet:[1,4,6,8,14],pars:1,parse_oss_url:1,part:20,pass:1,path:[1,6,8,18],per:[13,15],perform:14,pgp:16,pgpk:16,pgpv:16,pip:[15,16],pleas:[8,16],po:1,poke:8,polici:15,posit:1,prepar:13,present:8,previou:16,primari:16,process:18,properli:[18,20],provid:[16,18,20],provide_bucket_nam:1,provider_download_dir:16,pull:8,py3:16,py:20,pyi:13,pypi:[13,15],python:[4,15,16],read:[1,4,18],read_kei:1,readm:15,recommend:16,refactor:[13,15],refer:6,region:[1,6,8,13,20],reinstat:13,rel:8,relat:13,releas:[13,15],relev:16,remot:[1,4,13,15],remote_base_log_fold:18,remote_log:18,remote_log_conn_id:18,remote_log_loc:4,remov:[13,16],render:6,repositori:15,resourc:[8,14],return_error:4,root:8,rsa:16,rule:20,run:[13,15,16],s:[4,8,13,16],same:6,sat:16,save:[1,6],schema:14,script:16,sdist:16,secret:14,secur:14,see:[13,15],select:16,self:[1,4,6,8,16],sensor:[2,9],sep:16,septemb:13,sequenc:[8,13],server:16,servic:[14,20],set:[1,4],set_context:4,setup:18,sever:20,sha512:16,sha:16,shasum:16,should:16,sign:[14,16],signatur:16,silent:4,softwar:16,sourc:[1,4,6,8,10,11,15,20],specif:13,specifi:[1,8,14],sphinx:13,ssl:[13,15],st:14,start:18,start_dat:[13,20],step:16,storag:[1,4,18,20],store:18,str:[1,6,8],strai:13,string:[1,4,13],stub:13,style:8,subject:13,success:20,sum:16,suppli:18,support:[8,13,14,15],system:20,t:[1,18],tag:20,taken:1,tar:16,task1:20,task2:20,task:[4,15],task_id:20,teardown:20,templat:[6,13,15],template_field:[8,13],temporari:16,test:20,test_run:[10,11],thi:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20],those:16,ti:4,token:14,top:[15,16],trigger:20,trove:15,trust:16,tupl:1,type:[1,13,14,15],typehint:13,unifi:1,unify_bucket_name_and_kei:1,unknown:16,updat:[13,15],upload:[1,4,6],upload_local_fil:1,url:[1,8,14,18],us:[1,4,6,8,13,14,16,18,20],user:[14,16,18],util:[4,20],valid:16,valu:8,version:[13,15,16],via:[15,16],wa:4,wait:8,want:[6,16],warn:16,watcher:20,we:20,well:16,when:[4,6,8,20],where:1,whether:1,whl:16,why:16,worri:16,write:[4,17],you:[6,15,16,18],your:20},titles:["<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.alibaba.cloud.hooks</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.alibaba.cloud.hooks.oss</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.alibaba.cloud</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.alibaba.cloud.log</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.alibaba.cloud.log.oss_task_handler</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.alibaba.cloud.operators</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.alibaba.cloud.operators.oss</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.alibaba.cloud.sensors</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.alibaba.cloud.sensors.oss_key</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.alibaba</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">tests.system.providers.alibaba.example_oss_bucket</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">tests.system.providers.alibaba.example_oss_object</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">tests.system.providers.alibaba</span></code>","Package apache-airflow-providers-alibaba","Alibaba Cloud Connection","<code class=\"docutils literal notranslate\"><span class=\"pre\">apache-airflow-providers-alibaba</span></code>","Installing from sources","Logging for Tasks","Writing logs to Alibaba OSS","Alibaba Cloud Operators","Alibaba Cloud OSS Operators"],titleterms:{"0":[13,15],"1":[13,15],"2":[13,15],"break":15,"class":[1,4,6,8],"default":14,"function":1,airflow:[0,1,2,3,4,5,6,7,8,9,13,15],alibaba:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,18,19,20],apach:[13,15],attribut:1,authent:14,bucket:20,bug:15,chang:15,changelog:15,cloud:[0,1,2,3,4,5,6,7,8,14,19,20],commit:15,configur:14,connect:14,content:[1,4,6,8,10,11,15],creat:20,defin:20,delet:20,enabl:18,exampl:14,example_oss_bucket:10,example_oss_object:11,extra:14,featur:15,field:14,fix:15,from:16,guid:15,hook:[0,1],id:14,instal:[15,16],integr:16,log:[3,4,17,18],misc:15,modul:[1,4,6,8,10,11],oper:[5,6,19,20],oss:[1,6,18,20],oss_kei:8,oss_task_handl:4,overview:20,packag:[13,15,16],provid:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,15],purpos:20,pypi:16,refer:15,releas:16,remot:18,requir:15,resourc:15,sensor:[7,8],sourc:16,submodul:[0,3,5,7,12],subpackag:[2,9],system:[10,11,12],task:[17,20],test:[10,11,12],verifi:16,write:18}})