| Search.setIndex({docnames:["_api/airflow/providers/jenkins/hooks/index","_api/airflow/providers/jenkins/hooks/jenkins/index","_api/airflow/providers/jenkins/index","_api/airflow/providers/jenkins/operators/index","_api/airflow/providers/jenkins/operators/jenkins_job_trigger/index","_api/airflow/providers/jenkins/sensors/index","_api/airflow/providers/jenkins/sensors/jenkins/index","_api/tests/system/providers/jenkins/example_jenkins_job_trigger/index","_api/tests/system/providers/jenkins/index","commits","connections","index","installing-providers-from-sources"],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/jenkins/hooks/index.rst","_api/airflow/providers/jenkins/hooks/jenkins/index.rst","_api/airflow/providers/jenkins/index.rst","_api/airflow/providers/jenkins/operators/index.rst","_api/airflow/providers/jenkins/operators/jenkins_job_trigger/index.rst","_api/airflow/providers/jenkins/sensors/index.rst","_api/airflow/providers/jenkins/sensors/jenkins/index.rst","_api/tests/system/providers/jenkins/example_jenkins_job_trigger/index.rst","_api/tests/system/providers/jenkins/index.rst","commits.rst","connections.rst","index.rst","installing-providers-from-sources.rst"],objects:{"airflow.providers":[[2,0,0,"-","jenkins"]],"airflow.providers.jenkins":[[0,0,0,"-","hooks"],[3,0,0,"-","operators"],[5,0,0,"-","sensors"]],"airflow.providers.jenkins.hooks":[[1,0,0,"-","jenkins"]],"airflow.providers.jenkins.hooks.jenkins":[[1,1,1,"","JenkinsHook"]],"airflow.providers.jenkins.hooks.jenkins.JenkinsHook":[[1,2,1,"","conn_name_attr"],[1,2,1,"","conn_type"],[1,2,1,"","default_conn_name"],[1,3,1,"","get_build_building_state"],[1,3,1,"","get_jenkins_server"],[1,2,1,"","hook_name"]],"airflow.providers.jenkins.operators":[[4,0,0,"-","jenkins_job_trigger"]],"airflow.providers.jenkins.operators.jenkins_job_trigger":[[4,1,1,"","JenkinsJobTriggerOperator"],[4,4,1,"","JenkinsRequest"],[4,4,1,"","ParamType"],[4,5,1,"","jenkins_request_with_headers"]],"airflow.providers.jenkins.operators.jenkins_job_trigger.JenkinsJobTriggerOperator":[[4,3,1,"","build_job"],[4,3,1,"","execute"],[4,3,1,"","get_hook"],[4,3,1,"","poll_job_in_queue"],[4,2,1,"","template_ext"],[4,2,1,"","template_fields"],[4,2,1,"","ui_color"]],"airflow.providers.jenkins.sensors":[[6,0,0,"-","jenkins"]],"airflow.providers.jenkins.sensors.jenkins":[[6,1,1,"","JenkinsBuildSensor"]],"airflow.providers.jenkins.sensors.jenkins.JenkinsBuildSensor":[[6,3,1,"","poke"]],"tests.system.providers":[[8,0,0,"-","jenkins"]],"tests.system.providers.jenkins":[[7,0,0,"-","example_jenkins_job_trigger"]],"tests.system.providers.jenkins.example_jenkins_job_trigger":[[7,4,1,"","DAG_ID"],[7,4,1,"","ENV_ID"],[7,4,1,"","JENKINS_CONNECTION_ID"],[7,4,1,"","job_trigger"],[7,4,1,"","test_run"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","attribute","Python attribute"],"3":["py","method","Python method"],"4":["py","data","Python data"],"5":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:attribute","3":"py:method","4":"py:data","5":"py:function"},terms:{"0":[0,1,2,3,4,5,6,7,8,10,12],"00642a46d0":9,"0080354502":9,"01":9,"02":9,"027b707d21":9,"03":9,"04":9,"05":9,"05443c6dc8":9,"06":9,"07":9,"08":9,"09":9,"0a0e1af800":9,"0a68588479":9,"0b0e4f7a4c":9,"0b2":9,"0beta1":9,"1":4,"10":[4,9,11],"10097":9,"10205":9,"10468":9,"10483":9,"10528":9,"10543":9,"11":[9,12],"11238":9,"11242":9,"11249":9,"11447":9,"11487":9,"11688":9,"11825":9,"11826":9,"11855":9,"12":[9,12],"12082":9,"12093":9,"12122":9,"12206":9,"12212":9,"12304":9,"12366":9,"12390":9,"12444":9,"12449":9,"12558":9,"12917":9,"12955":9,"12af6a0800":9,"12c5e5d8a":9,"13":9,"13148":9,"13380":9,"13717":9,"13732":9,"13767":9,"14":9,"14013":9,"14131":[9,11],"14487":9,"14886":9,"15":[4,9],"15200":9,"15518":9,"15576":9,"15667":[9,11],"15baf737e":9,"16":9,"16294":9,"16405":9,"16464":9,"16501":9,"16532":9,"16682":9,"16874":9,"16963":[9,11],"16adc035b1":9,"16e7129719":9,"17":9,"17015":9,"17020":9,"17116":9,"17682":9,"17890":9,"18":9,"18278":9,"18613":9,"18855":9,"19":9,"19019":[9,11],"19064":[9,11],"19321":9,"1fba5402bb":9,"2":[0,1,2,3,4,5,6,7,8,10,12],"20":9,"2020":9,"2021":[9,12],"2022":9,"20523":9,"20571":9,"20608":9,"20614":9,"20951":9,"21":9,"21257":9,"21439":9,"22":9,"22056":9,"22226":9,"22382":11,"22383":9,"22421":[9,11],"22451":9,"22608":[9,11],"22802":[9,11],"22819":9,"23":9,"23104":9,"23631":9,"23rc1":9,"24":9,"24138":9,"24229":9,"24231":9,"24292":9,"25":9,"26":9,"266384a63f":9,"27":9,"28":9,"29":9,"295d66f914":9,"2a1":9,"3":[0,1,2,3,4,5,6,7,8,10,12],"30":9,"31":9,"32971a1a2d":9,"3320e432a1":9,"349b0811c3":9,"3696c34c28":9,"375d1ca229":9,"37681bca00":9,"3fd5ef3555":9,"4":[0,1,2,3,4,5,6,7,8,10,12],"406f":12,"40a2476a5d":9,"41bf172c1d":9,"443":10,"49":12,"4bde99f132":9,"4d03e33c11":9,"4d3a":12,"4e24b22379":9,"4e8f9cc8d0":9,"512":12,"5220e4c384":9,"54":12,"56ab82ed7a":9,"589d6dec92":9,"59eb5de78c":9,"5a439e84eb":9,"5bd64183f9":9,"5c6e":12,"602abe8394":9,"633eca1de5":9,"6656":9,"6674":[9,12],"6692":9,"6714":9,"6804":9,"6817":9,"6889a333cf":9,"68e4c4dcb0":9,"6c3a67d4fc":9,"6cf76d7ac0":9,"717a7588bc":9,"7272":9,"7287":9,"7304":9,"7338":9,"73a08ed757":9,"7419":9,"7456":9,"7517":9,"75c60923e0":9,"76ed2a49c6":9,"7802":9,"7825e8f590":9,"7828":9,"78adaed5e6":9,"7c206a82a6":9,"7d24b088cd":9,"8":9,"807ad32ce5":9,"83c037873f":9,"83f8e178ba":9,"840ea3efb9":9,"85a18e13d9":9,"85bedd03c3":9,"866a601b76":9,"86a2a19ad2":9,"872b1566a1":9,"87f408b1e7":9,"8807":9,"8886":9,"8891":9,"8898":9,"88bdcfa0df":9,"8994":9,"8afdb6ac6a":9,"8b6b0848a3":9,"8c42cf1b00":9,"8ec4":12,"9026":9,"92585ca4cb":9,"9320":9,"9370":9,"9404":9,"9408":9,"9550":9,"97496ba2b4":9,"97a429f9d0":9,"9947":9,"9985":9,"9b39f24780":9,"9c94b72d44":9,"9ff781ad8f":9,"class":[9,11],"default":4,"do":[4,12],"export":10,"final":9,"function":6,"import":[9,11,12],"int":[4,6],"long":4,"new":9,"return":[4,9,11],"super":9,"switch":9,"true":10,"while":[4,6],By:12,For:[9,10,12],If:[11,12],It:[4,12],NOT:10,The:[4,6,12],There:12,To:[4,12],__init__:9,a458fcc573:9,a777537594:9,a83be66840:9,a9ac2b040b:9,about:[9,12],abov:12,ac2f72c98d:9,accord:9,ad:[9,11],add:[4,9,11],addit:4,address:10,ae7cb4a1e2:9,aeabe994b3:9,aeea71274d:9,after:9,aip:9,airflow:12,airflow_conn_jenkins_default:10,aka:12,all:[9,10,11],allow:4,allowed_jenkins_st:[4,9,11],along:4,alreadi:12,also:[4,12],amazon:9,an:[0,1,2,3,4,5,6,7,8,9,10,11,12],ani:12,annot:9,answer:4,apach:12,apache_airflow_providers_jenkin:12,api:[4,9,11],appear:4,appli:[9,11],applic:9,apply_default:[9,11],april:9,ar:[11,12],arg:9,asc:12,assig:9,assign:[4,9],augment:9,august:9,auto:[9,11],autoapi:9,autom:9,automat:11,avail:[11,12],b2a28d1590:9,b40dffa085:9,b916b75079:9,ba4b:12,backport:9,base:[1,4,6],basehook:1,baseoper:4,basesensoroper:6,bash:12,basic:9,batch:9,bbc627a3da:9,be75dcd39c:9,belong:12,below:[11,12],between:4,bin:12,binari:12,black:9,blob:11,block:4,bodi:4,brees:9,broken:9,bst:12,bug:9,bugfix:9,buggfix:9,build:[1,4,6,9,12],build_job:4,build_numb:[1,4,6],builtin:9,c30ab6945:9,c34ef853c8:9,c7e5bce57f:9,ca4238eb4d:9,call:[4,9],can:[4,11,12],candid:9,cbf8001d76:9,cde15c6e4d3a8ec4ecf4ba4b6674e08ad7de406f:12,cde1:12,cdec301254:9,ceea293c16:9,certif:12,certifi:12,chang:[4,9],changelog:9,chapter:12,charact:9,check:[6,9,11,12],checksum:12,choos:12,classifi:[9,11],clean:[9,11],cleanup:9,code:12,com:[10,11,12],come:[4,9],command:9,comment:9,commit:9,commun:4,compat:9,complet:11,compon:10,concaten:9,condit:[9,11],conf:9,configur:4,conn_id:1,conn_name_attr:1,conn_typ:1,connect:[1,4,6,9,11],constructor:9,contain:[4,10,12],context:[4,6],contributor:9,correct:[9,12],correspond:4,creat:[4,12],cross:9,curl:12,d02ded65ea:9,d0e7db4024:9,d200:9,d56e7b56bb:9,d7dbfb7e26:9,d7de:12,d94fa37830:9,d9567eb106:9,d:12,dag:[9,11],dag_id:7,data:9,db:11,dbcd3d8787:9,decemb:9,decor:[9,11],default_arg:9,default_conn_nam:1,defin:6,delai:9,dep:12,depend:[4,6,9],deriv:[4,6],describ:12,descript:9,design:9,dest:12,detail:[9,11,12],dev0:[0,1,2,3,4,5,6,7,8,9,10,11,12],dev:9,dict:4,dictionari:4,diff:12,differ:12,directori:12,distribut:12,distutil:[9,11],doc:9,document:[9,11],doubl:9,down:12,download:12,drop:12,due:11,dynam:9,e08a:12,e4888a061f:9,e5dd6fdcfd:9,each:4,ecf4:12,echo:12,ee7ca128a1:9,enabl:9,encod:10,enter:10,entri:9,env_id:7,environ:10,escap:9,essenti:12,even:9,exampl:[9,10,11,12],example_dag:9,example_jenkins_job_trigg:[8,9],excluded_pattern:9,execut:4,exist:11,exit:4,experiment:[0,1,2,3,4,5,6,7,8,9,10,11,12],explain:11,explanatori:9,explicit:9,express:9,ext:9,extra:[9,10,11],f3521fb0e3:9,f5b96315fe:9,f6bd817a3a:9,f77417eb0d:9,f9ec86:4,f:9,face:9,fals:10,fdd9b6f65b:9,featur:[0,1,2,3,4,5,6,7,8,9,10,12],feb:9,field:[4,9],file:[4,9,11,12],fingerprint:12,finish:6,first:[4,11],fix:9,flynt:9,folder:12,follow:12,form:9,formmatt:9,foundat:12,framework:11,fresh:9,friendli:9,from:[4,9,11],gener:9,get:[1,4,12],get_build_building_st:1,get_hook:4,get_jenkins_serv:1,get_template_context:4,github:11,gmail:12,good:12,gpg:12,grammar:9,guid:12,gz:12,hash:9,have:[4,9,11],header:4,high:9,hook:[2,4,9,10],hook_nam:1,host:10,how:[4,12],http:[10,11,12],i:12,id:12,imag:9,implement:9,implicit:9,improv:9,includ:9,indic:12,individu:9,inform:9,initi:11,instal:9,install_requir:11,instanti:4,instruct:12,integr:9,interact:9,introduc:9,issuer:12,iter:4,its:4,januari:9,jenkin:12,jenkins_connection_id:[4,6,7],jenkins_default:[1,10],jenkins_job_trigg:[2,3],jenkins_request:4,jenkins_request_with_head:4,jenkins_serv:4,jenkinsbuildsensor:[6,9,11],jenkinshook:1,jenkinsjobtriggeroper:[4,9,11],jenkinsrequest:4,jinja:4,job:[4,6],job_nam:[1,4,6],job_trigg:7,json:4,juli:9,june:9,just:4,k8:9,ka:12,kaxil:12,kaxilnaik:12,keep:9,kei:[4,9,11,12],know:[4,12],kwarg:[4,6],l:12,la:12,latest:[6,9],lazi:9,lazili:9,least:11,left:12,level:9,librari:[4,6],like:[4,10],line:9,link:[9,12],list:[9,11],ll:4,load:9,local:12,locat:4,login:10,logo:9,ls:12,made:12,magic:9,mai:9,main:[4,11,12],make:[4,9],manag:[1,9,12],manual:11,march:9,markdown:9,match:[9,12],max:9,max_try_before_job_appear:4,maximum:4,md:[9,11],mean:4,meta:9,method:4,mid:9,migrat:[9,11],min:[4,9],minimum:11,mirror:12,miscellan:9,miss:9,mistakenli:11,mktemp:12,model:4,modul:9,monitor:[4,6],month:9,more:[4,9],most:12,move:9,mypi:9,naik:12,name:[4,6,9],need:4,next:9,none:[4,6,9,11,12],note:[9,10],now:9,number:[4,6,9,10,11],o:12,object:[4,9,11],octob:9,offici:12,onc:12,one:12,onli:11,oper:[2,9,10],optimis:11,option:[4,6,10],org:12,origin:12,otherwis:11,our:9,out:9,outcom:6,overrid:6,owner:12,package_nam:12,package_vers:12,page:[9,12],param:4,paramet:[4,6,9],paramtyp:4,pass:6,password:10,per:9,pgp:12,pgpk:12,pgpv:12,pip:[9,11,12],pleas:12,point:9,poke:6,polici:11,poll:4,poll_job_in_queu:4,port:10,prepar:9,previou:12,primari:12,project:9,provid:[10,12],provider_download_dir:12,pull:9,put:4,py3:12,py:9,pydocstyl:9,pylint:9,pypi:[9,11],python:[4,6,9,11,12],pyupgrad:9,queri:4,queue:4,rc2:9,rc3:9,readm:[9,11],rebas:9,recommend:12,ref:9,refer:4,refernc:9,regardless:6,regener:9,relas:9,relat:10,releas:[9,11],relev:12,rema:9,remain:9,remov:[9,11,12],renam:9,render:4,replac:9,repositori:11,req:4,request:4,respons:[4,9,11],result:4,rsa:12,run:[11,12],s:[4,9,12],same:4,sat:12,scheme:10,screen:4,script:[9,12],sdist:12,see:[9,11],select:12,self:[1,4,6,12],sensor:[2,9],sep:12,separ:9,septemb:9,sequenc:[4,9],server:[1,4,10,12],servic:10,setup:9,sha512:12,sha:12,shasum:12,should:[4,6,10,12],sign:12,signatur:[9,12],simplifi:9,sleep:4,sleep_tim:4,so:4,softwar:12,sourc:[1,4,6,7,11],specif:9,specifi:10,spell:9,sphinx:9,squash:9,start:4,start_dat:9,state:[1,4],statu:4,step:12,stop:9,str:[4,6],string:9,subject:9,success:4,sum:12,support:[9,11],synchron:9,syntax:10,tar:12,taskflow:9,templat:4,template_ext:4,template_field:[4,9],temporari:12,test:9,test_jenkin:7,test_run:7,them:4,thi:[0,1,2,3,4,5,6,7,8,9,10,11,12],those:12,through:4,thu:4,toc:9,too:10,tool:9,toolchain:9,top:[11,12],transfer:9,trigger:4,trove:11,trust:12,type:[4,9,10,11],typehint:9,typo:9,ui_color:4,unknown:12,until:4,untouch:9,up:[9,11],updat:[9,11],upgrad:[9,11],uri:10,url:10,us:[4,6,9,10,12],usag:[9,11],user:[9,12],usernam:10,utf:9,valid:12,variabl:10,verifi:9,version:[4,9,11,12],via:[11,12],wait:4,want:[10,11,12],warn:[9,12],wave:9,we:4,well:12,when:[4,6,9,10],where:[4,9],whether:10,which:4,whl:12,why:12,without:4,word:9,worri:12,would:10,wrong:9,wrongli:9,xcomarg:9,xml:4,you:[4,10,11,12],your:[10,11],your_jenkins_connect:7},titles:["<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.jenkins.hooks</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.jenkins.hooks.jenkins</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.jenkins</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.jenkins.operators</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.jenkins.operators.jenkins_job_trigger</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.jenkins.sensors</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.jenkins.sensors.jenkins</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">tests.system.providers.jenkins.example_jenkins_job_trigger</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">tests.system.providers.jenkins</span></code>","Package apache-airflow-providers-jenkins","Jenkins Connecting","<code class=\"docutils literal notranslate\"><span class=\"pre\">apache-airflow-providers-jenkins</span></code>","Installing from sources"],titleterms:{"0":[9,11],"1":[9,11],"2":[9,11],"3":[9,11],"4":[9,11],"5":[9,11],"6":[9,11],"7":[9,11],"break":11,"class":[1,4,6],"default":10,"function":4,airflow:[0,1,2,3,4,5,6,9,11],apach:[9,11],attribut:4,bug:11,chang:11,changelog:11,commit:11,configur:10,connect:10,content:[1,4,6,7,11],example_jenkins_job_trigg:7,featur:11,fix:11,from:12,guid:11,hook:[0,1],id:10,instal:[11,12],integr:12,jenkin:[0,1,2,3,4,5,6,7,8,9,10,11],jenkins_job_trigg:4,misc:11,modul:[1,4,6,7],oper:[3,4],packag:[9,11,12],provid:[0,1,2,3,4,5,6,7,8,9,11],pypi:12,refer:11,releas:12,requir:11,resourc:11,sensor:[5,6],sourc:12,submodul:[0,3,5,8],subpackag:2,system:[7,8],test:[7,8],verifi:12}}) |