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