blob: c1d69bf195033f2e8d987bcf4379250b9b7293c2 [file] [log] [blame]
Search.setIndex({docnames:["_api/airflow/providers/http/hooks/http/index","_api/airflow/providers/http/hooks/index","_api/airflow/providers/http/index","_api/airflow/providers/http/operators/http/index","_api/airflow/providers/http/operators/index","_api/airflow/providers/http/sensors/http/index","_api/airflow/providers/http/sensors/index","commits","connections/http","index","installing-providers-from-sources","operators"],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/http/hooks/http/index.rst","_api/airflow/providers/http/hooks/index.rst","_api/airflow/providers/http/index.rst","_api/airflow/providers/http/operators/http/index.rst","_api/airflow/providers/http/operators/index.rst","_api/airflow/providers/http/sensors/http/index.rst","_api/airflow/providers/http/sensors/index.rst","commits.rst","connections/http.rst","index.rst","installing-providers-from-sources.rst","operators.rst"],objects:{"airflow.providers":[[2,0,0,"-","http"]],"airflow.providers.http":[[1,0,0,"-","hooks"],[4,0,0,"-","operators"],[6,0,0,"-","sensors"]],"airflow.providers.http.hooks":[[0,0,0,"-","http"]],"airflow.providers.http.hooks.http":[[0,1,1,"","HttpHook"]],"airflow.providers.http.hooks.http.HttpHook":[[0,2,1,"","check_response"],[0,3,1,"","conn_name_attr"],[0,3,1,"","conn_type"],[0,3,1,"","default_conn_name"],[0,2,1,"","get_conn"],[0,3,1,"","hook_name"],[0,2,1,"","run"],[0,2,1,"","run_and_check"],[0,2,1,"","run_with_advanced_retry"],[0,2,1,"","test_connection"],[0,2,1,"","url_from_endpoint"]],"airflow.providers.http.operators":[[3,0,0,"-","http"]],"airflow.providers.http.operators.http":[[3,1,1,"","SimpleHttpOperator"]],"airflow.providers.http.operators.http.SimpleHttpOperator":[[3,2,1,"","execute"],[3,3,1,"","template_ext"],[3,3,1,"","template_fields"],[3,3,1,"","template_fields_renderers"],[3,3,1,"","ui_color"]],"airflow.providers.http.sensors":[[5,0,0,"-","http"]],"airflow.providers.http.sensors.http":[[5,1,1,"","HttpSensor"]],"airflow.providers.http.sensors.http.HttpSensor":[[5,2,1,"","poke"],[5,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"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute"},terms:{"0":[0,1,2,3,4,5,6,8,10,11],"00642a46d0":7,"0080354502":7,"01":7,"02":7,"0264fea8c2":7,"03":7,"04":7,"05":7,"06":7,"07":7,"08":7,"09":7,"0a0e1af800":7,"0a3ff43d41":7,"0a68588479":7,"0b0e4f7a4c":7,"0b2":7,"0beta1":7,"0dbd0f420c":7,"1":[0,1,2,3,4,5,6,8,10,11],"10":[0,7,9],"10097":7,"10163":7,"10205":7,"10343ec29f":7,"10483":7,"10485":7,"10528":7,"10543":7,"10818":7,"11":[7,10],"11238":7,"11242":7,"11249":7,"11487":7,"11555":7,"11826":7,"11855":7,"11922":7,"12":[7,10],"12082":7,"12093":7,"12206":7,"12212":7,"12304":7,"12366":7,"12390":7,"12427":7,"12438":7,"12444":7,"12449":7,"12513":7,"12558":7,"12681":7,"12809":7,"12917":7,"12955":7,"12af6a0800":7,"12c5e5d8a":7,"12fdf9b4f9":7,"13":7,"13148":7,"13380":7,"13499":7,"13717":7,"13767":7,"13b2c400b9":7,"14":7,"14013":7,"14082":[7,9],"14487":7,"14701":[7,9],"14886":7,"15":7,"15379":7,"15576":7,"15605":[7,9],"15667":[7,9],"16":7,"16005":7,"1602ec97c8":7,"16294":7,"16405":7,"16464":7,"16501":7,"16568":7,"16682":7,"16872":7,"16adc035b1":7,"16e7129719":7,"17":7,"17015":7,"17116":7,"17682":7,"17890":7,"18":7,"18597":7,"18613":7,"19":7,"19321":7,"19882":7,"1fba5402bb":7,"2":[0,1,2,3,4,5,6,8,10,11],"20":7,"2020":7,"2021":[7,10],"2022":7,"20246":7,"20322":[7,9],"20523":7,"20565":7,"20571":7,"20608":7,"20614":7,"20951":7,"21":7,"21247":[7,9],"21257":7,"21398":7,"21439":7,"21831":[7,9],"22":7,"22056":7,"22226":7,"22382":9,"23":7,"23rc1":7,"24":7,"249e80b960":7,"24c8e4c2d6":7,"25":7,"26":[7,9],"27":7,"28":7,"29":7,"295d66f914":7,"2a1":7,"2f":11,"2fyour_host":11,"2xx":0,"30":7,"31":7,"32971a1a2d":7,"3320e432a1":7,"33f0cd2657":7,"3696c34c28":7,"370e7d07d1":7,"375d1ca229":7,"37681bca00":7,"3a":11,"3cddc11821":7,"3fd5ef3555":7,"3xx":0,"4":[0,1,2,3,4,5,6,7,8,9,10,11],"403":5,"404":5,"406f":10,"40bf8f28f9":7,"41bf172c1d":7,"443":11,"4681":7,"49":10,"4bde99f132":7,"4d03e33c11":7,"4d3a":10,"4d74ac2111":7,"4dcc35e020":7,"4e8f9cc8d0":7,"5":11,"512":10,"5156":7,"5220e4c384":7,"54":10,"589d6dec92":7,"59eb5de78c":7,"5a439e84eb":7,"5c6e":10,"6":7,"602abe8394":7,"61fdf8442e":7,"6646":7,"6674":[7,10],"6714":7,"6792":7,"6817":7,"6889a333cf":7,"68e4c4dcb0":7,"6c3a67d4fc":7,"6cf76d7ac0":7,"7268":7,"7287":7,"7309":7,"7338":7,"7412":7,"7456":7,"7517":7,"76ed2a49c6":7,"7802":7,"7825e8f590":7,"7826":7,"7ca0b6f121":7,"7d24b088cd":7,"8":7,"80":8,"807ad32ce5":7,"83c037873f":7,"83f8e178ba":7,"840ea3efb9":7,"8429":7,"8434":7,"853576d901":7,"8591":7,"85a18e13d9":7,"866a601b76":7,"872b1566a1":7,"87f408b1e7":7,"8807":7,"8886":7,"8891":7,"8898":7,"88bdcfa0df":7,"8994":7,"8b1":7,"8ec4":10,"9026":7,"904709d34f":7,"92585ca4cb":7,"9290":7,"9320":7,"9370":7,"9404":7,"9408":7,"9549274d11":7,"9550":7,"9729":7,"97496ba2b4":7,"9784":7,"97a429f9d0":7,"9876e19273":7,"9885":7,"9985":7,"9a04013b0":7,"9b39f24780":7,"9c94b72d44":7,"9cbd7de6d1":7,"break":11,"case":11,"class":[7,9],"default":[0,3,7,9,11],"do":[5,10],"export":8,"final":7,"function":[3,5,7,11],"import":[7,9,10],"long":11,"new":[7,9],"return":[0,3,5,11],"static":7,"super":7,"true":[3,5,11],"while":5,A:[0,3,5],AS:11,As:11,By:10,For:[0,3,5,7,8,10,11],If:[9,10,11],In:[5,11],It:[3,5,10],Not:5,The:[0,3,5,8,10,11],Then:11,There:10,To:[5,10],__init__:7,_hook:7,_oper:7,_retry_arg:0,_sensor:7,a0821235fb:7,about:[7,10],abov:10,ac2f72c98d:7,ac93419d1d:7,accept:[7,9],access:5,accord:[7,11],action:3,actual:0,ad:[3,5,7,9,11],add:[7,9],addit:0,ae7cb4a1e2:7,aeea71274d:7,after:[7,9],against:[3,5,11],aip:7,airflow:[10,11],airflow_conn_http_default:8,airflowexcept:0,aka:10,all:[7,8,9,11],allow:3,along:8,alreadi:[10,11],also:[0,5,10,11],altern:11,an:[0,1,2,3,4,5,6,7,8,9,10,11],ani:[0,3,5,8,10],apach:10,apache_airflow_providers_http:10,api:[0,7,9,11],appli:[7,9],applic:[8,11],apply_default:[7,9],ar:[5,9,10,11],arg:[0,7],argument:[0,3,5,7,9],asc:10,attach:0,attribut:[7,9,11],august:7,auth:[0,3,7,9],auth_typ:[0,3],authbas:3,authent:0,auto:[7,9],autoapi:7,autom:7,automat:[7,9],avail:[3,5,10],avoid:[0,5],b2a28d1590:7,b40dffa085:7,b916b75079:7,ba4b:10,back:11,backport:7,backward:11,badd890675:7,base:[0,3,5,8],basehook:0,baseoper:3,basesensoroper:5,bash:10,basic:11,batch:7,bbc627a3da:7,bd90136aaf:7,be2b2baa7c:7,be75dcd39c:7,becaus:11,befor:11,behaviour:0,being:11,belong:10,below:[10,11],bin:10,binari:10,black:7,bodi:11,bool:[3,5],broken:7,bst:10,buggfix:7,build:[7,10,11],c1cd50465c:7,c34ef853c8:7,c7e5bce57f:7,ca4238eb4d:7,ca432eebdf:7,call:[0,3,7,11],callabl:[3,5,7,11],can:[0,5,8,9,10,11],candid:7,caus:5,cbf8001d76:7,cde15c6e4d3a8ec4ecf4ba4b6674e08ad7de406f:10,cde1:10,cdec301254:7,certif:10,certifi:10,chang:[7,11],changelog:7,chapter:10,check:[0,3,5,7,10],check_respons:[0,5],checksum:10,choos:10,classifi:[7,9],cleanup:7,code:[0,5,7,9,10,11],com:[0,8,10],combin:[0,7,9],come:7,command:7,comment:7,commit:7,compat:[7,11],complet:9,compon:[8,11],configur:11,confus:[7,9],conn_name_attr:0,conn_typ:0,connect:[0,3,5,7,9,11],connectionerror:0,connector:0,constructor:7,consum:11,contain:[10,11],content:11,context:[3,5,7],continu:7,convert:11,correct:[7,9,10],could:11,counter:11,creat:[0,3,10],credenti:0,cross:7,csv:11,curl:10,d0e7db4024:7,d56e7b56bb:7,d61a476da3:7,d7bc217957:7,d7de:10,d94fa37830:7,d9567eb106:7,d:10,dag:[5,7,9,11],data:[0,3,5,7,11],databas:11,db:9,dc3a4938ca:7,ddd005e3b9:7,decemb:7,decor:[0,7,9],def:5,default_arg:7,default_conn_nam:0,defin:[0,5],definit:11,del_op:11,delai:7,delet:11,dep:10,depend:[7,9],deprecationwarn:[7,9],deriv:[3,5],describ:10,descript:7,dest:10,detail:[7,9,10],detect:7,dev0:[0,1,2,3,4,5,6,7,8,9,10,11],dev:7,dict:[0,3,5],dictionari:[0,3,5],diff:10,differ:[10,11],difficult:11,directli:5,directori:10,distribut:10,disturb:0,doc:[7,9],docstr:7,document:[0,3,5,7,9],down:10,download:10,downstream:11,drop:10,ds:5,due:9,dump:11,duplic:7,dynam:7,e08a:10,e:[0,3],easi:11,ecf4:10,echo:10,ee7ca128a1:7,ef037e7021:7,ellipsi:[3,5],enabl:[7,8],encod:[8,11],endpoint:[0,3,5,11],entir:8,entri:7,environ:8,equal:11,error:[5,7],essenti:10,etc:[3,5,8],evalu:11,even:7,everywher:7,exampl:[0,7,8,9,10,11],example_dag:[7,11],example_http:[7,11],except:[0,5],execut:[0,3,5],execution_d:5,exist:9,experiment:[0,1,2,3,4,5,6,7,8,9,10,11],explicit:7,express:7,ext:7,extend:7,extra:[0,3,5,8],extra_opt:[0,3,5],f122e2826d:7,f3521fb0e3:7,f3ad5cf618:7,f4a460:3,f5b96315fe:7,f6bd817a3a:7,f77417eb0d:7,face:7,factori:[7,9],fail:[0,5,11],failur:5,fals:[0,3,5],fdd9b6f65b:7,featur:[0,1,2,3,4,5,6,7,8,10,11],feb:7,field:[0,7,8,11],file:[7,9,10],fingerprint:10,first:[3,5,9,11],fix:7,folder:10,follow:[10,11],form:[5,7,11],format:[0,8],formmatt:7,found:5,foundat:10,framework:9,fresh:7,friendli:7,from:[7,9,11],full:[3,5,11],g:3,gener:[0,7],get:[0,3,5,10,11],get_conn:0,get_op:11,get_op_response_filt:11,get_template_context:3,github:0,give:11,given:8,gmail:10,good:10,googl:0,gpg:10,grab:0,grammar:7,grpc:7,guid:[3,5,7,10],gz:10,ha:0,hash:7,have:[7,9],head:7,header:[0,3,5,7,8,11],here:11,high:7,histor:11,hook:[2,7,8,11],hook_nam:0,host:[8,11],how:[3,5,10,11],howev:11,http:10,http_conn_id:[0,3,5,11],http_default:[0,3,5,8,11],http_sensor_check:11,httpbasicauth:[0,3],httpbin:11,httphook:[0,7,9],httpsensor:[5,7,9],hypertext:[7,9],i:[0,10],id:10,ignor:[7,9],implement:7,implicit:7,improv:7,includ:[7,11],increas:7,indic:10,individu:7,inform:[3,5,7],initi:9,inject:5,instal:7,install_requir:9,instantli:0,instead:11,instruct:10,integr:7,interact:0,interest:11,intermitt:0,introduc:7,intuit:11,issu:0,issuer:10,itself:5,januari:7,jd:0,jinja:3,joe:11,json:[0,3,8,11],juli:7,june:7,k8:7,ka:10,kaxil:10,kaxilnaik:10,keep:7,kei:10,keyword:[3,5,7],know:10,kwarg:[0,3,5],l:10,la:10,lack:7,lambda:[3,11],larg:11,latest:7,lazi:7,lazili:7,least:9,left:10,level:7,librari:[3,5],like:[0,5,8,11],line:7,link:[7,10],list:[7,9],load:[3,7],local:10,log:3,log_respons:3,logic:[7,9],login:8,logo:7,look:[3,5,11],ls:10,made:10,magic:7,main:[3,10],make:[5,7,11],manag:[7,10],mani:11,manipul:3,manual:9,march:7,markdown:7,markdownlint:7,match:[7,10],md003:7,md:7,mean:11,meta:7,method:[0,3,5,7,8,9,11],might:[0,11],migrat:9,mirror:10,misc:7,miscellan:7,miss:7,mistakenli:9,mktemp:10,model:3,modifi:[3,5,11],modul:7,month:7,more:[3,5,7],most:10,move:7,my_conn:0,my_endpoint:11,my_http_sensor:5,mypi:7,naik:10,name:[7,11],need:11,nest:11,next:[7,11],non:0,none:[0,3,5,10],note:[7,8],novemb:7,now:7,number:[3,5,7,8],o:10,obj:0,object:[0,3,5,7,9],octob:7,offici:10,onc:10,one:10,onli:11,oper:[2,5,7,8,9],optimis:9,option:[0,3,5,8],org:10,origin:[10,11],other:[5,7,11],otherwis:[3,5,9,11],our:7,out:[7,9],overrid:5,owner:10,package_nam:10,package_vers:10,page:[7,10],param1:11,param2:11,param:[3,7,11],paramet:[0,3,5,7,11],part:[3,5],pass:[0,3,5,11],password:8,path:[7,9,11],pattern:7,payload:[0,11],per:7,percent:11,perform:[0,11],pgp:10,pgpk:10,pgpv:10,pip:[7,10],pleas:10,point:7,poke:[5,7,11],poke_interv:11,port:8,posit:[3,5],post:[0,3,11],post_op:11,post_op_formenc:11,postgresoper:7,practic:5,pre:7,prefix:11,prepar:[0,7],preparedrequest:0,prepped_request:0,previou:10,primari:10,print:5,prioriti:11,project:7,properti:11,protocol:[7,9,11],provid:[10,11],provider_download_dir:10,pull:5,pushing_task:5,put:[3,11],put_op:11,py3:10,py:[7,11],pylint:7,pypi:[7,9],python:[7,9,10],pythonoper:7,queri:[0,11],rais:[0,5],rc2:7,rc3:7,rc:[7,9],re:11,readm:[7,9],reason:11,rebas:7,recommend:10,ref:7,refactor:7,refer:[3,7],refernc:7,refus:5,regardless:11,regener:7,rel:[3,5],relas:7,releas:[7,9],relev:10,reli:11,rema:7,remain:7,remov:[7,9,10],renam:7,render:3,replac:7,repositori:9,request:[0,3,5,7,9,11],request_kwarg:0,request_param:[5,11],resourc:0,respect:[7,9],respons:[0,3,5,11],response_check:[3,5,11],response_filt:[3,7,11],rest:11,result:0,retri:0,retriev:11,retry_arg:0,rsa:10,rule:7,run:[0,3,5,9,10,11],run_and_check:0,run_with_advanced_retri:0,s:[7,10,11],same:[3,7,11],sat:10,schema:[8,11],scheme:11,script:[7,10],sdist:10,see:[0,3,5,7],select:10,self:[0,3,5,10],sensibl:5,sensor:[2,7],sent:11,sep:10,separ:[7,9],septemb:7,sequenc:[3,5,7],server:[0,10],servic:[0,3,8],servvic:8,session:0,set:11,setup:7,sha512:10,sha:10,shasum:10,should:[0,3,5,8,10,11],sign:10,signatur:[7,10],simplehttpoper:[3,7,9],simplifi:7,site:11,slack:7,snippet:7,so:5,softwar:10,some:[7,11],someth:5,sourc:[0,3,5,9,11],specif:11,specifi:[0,8],sphinx:7,split:[7,9],squash:7,ssl:[3,5],start_dat:7,statement:5,statu:[0,5,7,9],step:10,still:11,stop:[0,7],stop_after_attempt:0,str:[0,3,5],strign:7,string:7,stupid:11,style:7,subject:7,submit:11,subset:11,succe:11,sum:10,support:[7,9],synchron:7,synctat:7,syntax:8,system:[3,7],take:[3,5,7,9],tar:10,task:[5,11],task_del_op:11,task_get_op:11,task_get_op_response_filt:11,task_http_sensor_check:11,task_id:[5,7,11],task_inst:5,task_post_op:11,task_post_op_formenc:11,task_put_op:11,templat:[3,5],template_ext:3,template_field:[3,5,7],template_fields_rend:7,template_fields_render:3,temporari:10,tenac:0,test:[0,7],test_connect:0,text:[3,11],than:5,therefor:11,thi:[0,1,2,3,4,5,6,7,8,9,10,11],third:11,those:10,through:0,time:11,timeout:[0,3,5],toc:7,too:8,tool:[7,9],toolchain:7,top:[9,10,11],tradition:11,transfer:[7,9],trove:9,trust:10,type:[0,3,7,8,9,11],typehint:7,typo:7,ui_color:3,un:[7,9],union:0,unknown:10,until:11,untouch:7,up:7,updat:[7,9],upgrad:[7,9],upload:0,uri:[8,11],url:[0,3,5,8,11],url_from_endpoint:0,urlencod:11,us:[0,3,5,7,8,9,10,11],user:[7,10,11],usernam:8,usual:11,utf:7,v1:0,valid:10,valu:5,value1:11,value2:11,variabl:[5,8],version:[7,9,10],via:[9,10,11],wa:11,wai:11,wait:0,wait_exponenti:0,want:[9,10,11],warn:[7,10],wave:7,we:11,well:[10,11],when:[0,3,8,11],where:11,which:[0,11],whl:10,why:10,wish:11,without:11,word:7,work:11,worri:10,would:[5,8],wrong:7,wrongli:7,www:[0,11],x:11,xcom:5,xcom_data:5,xcom_pul:5,xml:11,you:[3,5,8,9,10,11],your:[9,11],your_host:11},titles:["<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.http.hooks.http</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.http.hooks</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.http</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.http.operators.http</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.http.operators</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.http.sensors.http</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.http.sensors</span></code>","Package apache-airflow-providers-http","HTTP Connection","<code class=\"docutils literal notranslate\"><span class=\"pre\">apache-airflow-providers-http</span></code>","Installing from sources","HTTP Operators"],titleterms:{"0":[7,9],"1":[7,9],"2":[7,9],"3":[7,9],"break":9,"class":[0,3,5],"default":8,airflow:[0,1,2,3,4,5,6,7,9],apach:[7,9],authent:8,bug:9,chang:9,changelog:9,commit:9,configur:8,connect:8,content:[0,3,5,9],featur:9,fix:9,from:10,guid:9,hook:[0,1],http:[0,1,2,3,4,5,6,7,8,9,11],httpsensor:11,id:8,instal:[9,10],integr:10,misc:9,modul:[0,3,5],oper:[3,4,11],packag:[7,9,10],pip:9,provid:[0,1,2,3,4,5,6,7,9],pypi:10,refer:9,releas:10,requir:9,resourc:9,sensor:[5,6],simplehttpoper:11,sourc:10,submodul:[1,4,6],subpackag:2,verifi:10}})