blob: 654eec00ceb753feccb9f85f80c5766e8dfdcae2 [file] [log] [blame]
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","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","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"]]},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,11,13,14,15,16,17],"01":10,"02":10,"03":10,"05":10,"07":10,"08":10,"09":10,"0fe0b06bb0":10,"1":[0,1,2,3,4,5,6,7,8,9,11,13,14,15,16,17],"10":[10,12],"11":[10,13],"12":[10,13],"13":10,"14":[10,12],"15":10,"16adc035b1":10,"17200":10,"17201":10,"17682":10,"18":10,"18019":10,"18597":10,"18613":10,"19":10,"19099":10,"19321":10,"19882":10,"2":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17],"20":10,"2021":[10,13,17],"2022":10,"20226":10,"20393":10,"20423":10,"20523":10,"20556":10,"20565":10,"20571":10,"20614":10,"20827":10,"20936":10,"20951":10,"21":10,"21014":10,"21257":10,"21439":10,"21785":[10,12],"22056":10,"22226":10,"22382":12,"23":10,"29":10,"2fb5e1d0ec":10,"3":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17],"30":10,"31":10,"3299064958":10,"406f":13,"49":13,"4d3a":13,"512":13,"54":13,"5c6e":13,"602abe8394":10,"6674":13,"6c3a67d4fc":10,"730db3fb77":10,"73ab0edce5":10,"73c0d241d8":10,"75ca6543da":10,"76ed2a49c6":10,"7bd8b2d7f3":10,"840ea3efb9":10,"853576d901":10,"8ec4":13,"97496ba2b4":10,"case":1,"class":12,"default":10,"do":13,"function":8,"import":[10,13],"int":1,"new":[4,10,17],"return":[1,4,8],"static":[1,10],"true":[1,4,15],"try":15,"while":8,By:13,For:[10,13],If:[4,13,15],In:[15,17],It:[4,13],The:[1,6,8,11,13],There:13,To:[13,15],a0821235fb:10,about:[10,13],abov:[13,15],access:[11,15],access_key_id:11,access_key_secret:11,ad:[10,12],add:[10,12],airflow:[13,15,17],ak:11,aka:13,alibaba:[13,14],alibabacloud_conn_id:1,all:[10,11,12],alreadi:13,also:13,an:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17],ani:[4,13],apach:13,apache_airflow_providers_alibaba:13,api:[1,12],append:[1,4],append_str:1,ar:[4,10,11,12,13],arg:[1,10],asc:13,auth:11,auth_typ:11,autoapi:10,avail:13,b5d520cf73:10,ba4b:13,base:[1,4,6,8],base_log_fold:4,basehook:1,baseoper:6,basesensoroper:8,bash:13,be75dcd39c:10,been:1,being:8,belong:13,below:13,bin:13,binari:13,bool:1,bst:13,bucket:[1,6,8,11,15],bucket_kei:8,bucket_nam:[1,6,8,17],build:13,cached_properti:10,can:[11,12,13,15],catchup:17,cde15c6e4d3a8ec4ecf4ba4b6674e08ad7de406f:13,cde1:13,certif:13,certifi:13,cfg:15,chang:10,changelog:10,chapter:13,check:[1,4,13],checksum:13,choos:13,classifi:[10,12],cleanup:10,close:4,cloud:[9,10,12],code:[13,17],com:13,commit:10,compat:10,concaten:10,configur:15,conn_name_attr:1,conn_typ:1,connect:[1,6,8,10,12,15],contain:[6,13],context:[4,6,8,10],correct:13,creat:[1,4,6,8,13],create_bucket:[1,17],credenti:[6,8],curl:13,d56e7b56bb:10,d7de:13,d94fa37830:10,d9567eb106:10,d:13,dag:[10,12,17],dag_id:17,data:10,datetim:17,decemb:10,declar:10,decor:1,default_arg:[10,17],default_conn_nam:1,defin:8,delai:10,delet:[1,6],delete_bucket:[1,17],delete_object:1,dep:13,deriv:[6,8],describ:13,descript:10,dest:13,detail:[10,12,13],dev0:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17],dictionari:[6,11],diff:13,differ:13,directori:[10,13],distribut:13,doc:10,document:10,doe:8,don:15,down:13,download:[1,6,13],download_fil:1,drop:13,e08a:13,ecf4:13,echo:13,ef037e7021:10,either:15,els:4,enabl:[10,12],error:[4,10],essenti:13,everywher:10,exampl:[10,12,13,15,17],example_dag:[10,17],example_oss_bucket:17,execut:6,exist:[1,4,12,15],experiment:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17],explain:10,extend:4,f5ad26dcdd:10,f5b96315fe:10,f77417eb0d:10,f8fd0f7b4c:10,fail:[4,15],fake:10,fals:[1,4,17],featur:[0,1,2,3,4,5,6,7,8,9,10,11,13,14,15,16,17],feb:10,few:10,file:[1,4,6,8,10,13],file_task_handl:4,filename_templ:4,filetaskhandl:4,find:1,fingerprint:13,fix:10,fixup:10,folder:[8,13],follow:[11,13,15,17],found:4,foundat:13,framework:12,friendli:10,from:[1,4,8,12],full:8,func:1,get:[1,13],get_bucket:1,get_conn:1,get_credenti:1,get_default_region:1,get_hook:8,get_template_context:6,given:17,gmail:13,good:13,gpg:13,guid:13,gz:13,ha:1,handl:4,handler:4,have:[10,15],head_kei:1,high:10,hook:[2,4,9,10,11],hook_nam:1,how:13,http:13,i:13,id:[13,15],includ:[10,12],indic:13,individu:10,info:1,inform:10,init:10,initi:12,install_requir:12,instanc:[4,8],instruct:13,integr:[10,12,17],interact:[1,17],introduc:10,isort:10,issuer:13,januari:10,jinja:6,json:11,just:8,k8:10,ka:13,kaxil:13,kaxilnaik:13,kei:[1,6,8,11,13],key_exist:1,know:13,kwarg:[1,6,8],l:13,la:13,latest:10,lazili:10,least:1,leav:8,left:13,level:[8,10],librari:1,like:[1,6,8],line:10,link:13,list:[1,6,10,12],load:1,load_str:1,local:[1,4,6,13],local_fil:[1,6],locat:[4,15],log:[2,9,10,12],logging_mixin:4,loggingmixin:4,ls:13,made:13,mai:11,main:[6,13],manag:[10,13],march:10,match:13,max_active_run:17,messag:4,meta:[1,10],method:6,mirror:13,misc:10,miss:10,mistakenli:12,mktemp:13,model:6,more:6,most:13,must:15,my:15,mypi:10,naik:13,name:[1,6,8,11,17],none:[1,6,8,13],novemb:10,now:[10,11],o:13,object:[1,4,6,17],object_exist:1,occur:4,octob:10,offici:13,onc:13,one:13,onli:11,oper:[2,9,12],option:[1,6,8,11],org:13,origin:13,oss2:[1,12],oss:[0,2,4,5,8,9,10,11,12,14,16],oss_bucket_dag:17,oss_conn_id:[1,6,8],oss_default:[1,6,8,11,15],oss_kei:[2,7,9],oss_log_exist:4,oss_log_fold:4,oss_read:4,oss_task_handl:[2,3,9,10,12],oss_writ:4,osscreatebucketoper:[6,17],ossdeletebatchobjectoper:[6,17],ossdeletebucketoper:[6,17],ossdeleteobjectoper:[6,17],ossdownloadobjectoper:[6,17],osshook:[1,8,15],osskeysensor:[8,17],osstaskhandl:4,ossuploadobjectoper:[6,17],ossurl:1,otherwis:4,out:1,overrid:8,overwritten:4,owner:13,package_nam:13,package_vers:13,page:13,paramet:[1,4,6,8,11],pars:1,parse_oss_url:1,pass:1,path:[1,6,8,15],perform:11,pgp:13,pgpk:13,pgpv:13,pip:13,pleas:[8,13],po:1,poke:8,posit:1,prepar:10,present:8,previou:13,primari:13,process:15,properli:15,provid:[13,15,17],provide_bucket_nam:1,provider_download_dir:13,py3:13,py:17,pyi:10,pypi:[10,12],python:[4,12,13],read:[1,4,15],read_kei:1,recommend:13,refer:6,region:[1,6,8,10,17],reinstat:10,rel:8,relat:10,releas:[10,12],relev:13,remot:[1,4,10,12],remote_base_log_fold:15,remote_log:15,remote_log_conn_id:15,remote_log_loc:4,remov:[10,13],render:6,repositori:12,resourc:[8,11],return_error:4,root:8,rsa:13,run:13,s:[4,8,10,13],same:6,sat:13,save:[1,6],schema:11,script:13,sdist:13,secret:11,secur:11,see:10,select:13,self:[1,4,6,8,13],sensor:[2,9],sep:13,septemb:10,sequenc:[8,10],server:13,servic:[11,17],set:1,set_context:4,setup:15,sever:17,sha512:13,sha:13,shasum:13,should:[8,13],sign:[11,13],signatur:13,silent:4,softwar:13,sourc:[1,4,6,8,12,17],specifi:[1,8,11],sphinx:10,st:11,start:15,start_dat:[10,17],step:13,storag:[1,4,15,17],store:15,str:[1,6,8],strai:10,string:[1,4,10],stub:10,style:8,subject:10,sum:13,suppli:15,support:[8,10,11,12],t:[1,15],tag:17,taken:1,tar:13,task1:17,task2:17,task:[4,12],task_id:17,task_inst:4,templat:6,template_field:[8,10],temporari:13,thi:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17],those:13,ti:4,token:11,top:[12,13],trove:12,trust:13,tupl:1,type:[1,10,11,12],typehint:10,unifi:1,unify_bucket_name_and_kei:1,unknown:13,updat:10,upload:[1,4,6],upload_local_fil:1,url:[1,8,11,15],us:[1,6,8,10,11,13,15,17],user:[11,13,15],util:4,valid:13,valu:8,version:[10,12,13],via:[12,13],wa:4,wait:8,want:[6,13],warn:13,we:17,well:13,when:[4,6,8],where:1,whether:1,whl:13,why:13,worri:13,write:[4,14],you:[6,12,13,15],your:17},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>","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":[10,12],"1":[10,12],"class":[1,4,6,8],"default":11,"function":1,airflow:[0,1,2,3,4,5,6,7,8,9,10,12],alibaba:[0,1,2,3,4,5,6,7,8,9,10,11,12,15,16,17],apach:[10,12],attribut:1,authent:11,bucket:17,bug:12,changelog:12,cloud:[0,1,2,3,4,5,6,7,8,11,16,17],commit:12,configur:11,connect:11,content:[1,4,6,8,12],creat:17,defin:17,delet:17,enabl:15,exampl:11,extra:11,featur:12,field:11,fix:12,from:13,guid:12,hook:[0,1],id:11,instal:[12,13],integr:13,log:[3,4,14,15],misc:12,modul:[1,4,6,8],oper:[5,6,16,17],oss:[1,6,15,17],oss_kei:8,oss_task_handl:4,overview:17,packag:[10,12,13],pip:12,provid:[0,1,2,3,4,5,6,7,8,9,10,12],purpos:17,pypi:13,refer:12,releas:13,remot:15,requir:12,resourc:12,sensor:[7,8],sourc:13,submodul:[0,3,5,7],subpackag:[2,9],task:[14,17],verifi:13,write:15}})