blob: daf5fa92020b089b7ff2d831a3909d3d78bb6f2c [file] [log] [blame]
Search.setIndex({docnames:["_api/airflow/providers/slack/example_dags/example_slack/index","_api/airflow/providers/slack/example_dags/index","_api/airflow/providers/slack/hooks/index","_api/airflow/providers/slack/hooks/slack/index","_api/airflow/providers/slack/hooks/slack_webhook/index","_api/airflow/providers/slack/index","_api/airflow/providers/slack/operators/index","_api/airflow/providers/slack/operators/slack/index","_api/airflow/providers/slack/operators/slack_webhook/index","commits","connections/slack","index","installing-providers-from-sources","operators/slack_operator_howto_guide"],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/slack/example_dags/example_slack/index.rst","_api/airflow/providers/slack/example_dags/index.rst","_api/airflow/providers/slack/hooks/index.rst","_api/airflow/providers/slack/hooks/slack/index.rst","_api/airflow/providers/slack/hooks/slack_webhook/index.rst","_api/airflow/providers/slack/index.rst","_api/airflow/providers/slack/operators/index.rst","_api/airflow/providers/slack/operators/slack/index.rst","_api/airflow/providers/slack/operators/slack_webhook/index.rst","commits.rst","connections/slack.rst","index.rst","installing-providers-from-sources.rst","operators/slack_operator_howto_guide.rst"],objects:{"airflow.providers":[[5,0,0,"-","slack"]],"airflow.providers.slack":[[1,0,0,"-","example_dags"],[2,0,0,"-","hooks"],[6,0,0,"-","operators"]],"airflow.providers.slack.example_dags":[[0,0,0,"-","example_slack"]],"airflow.providers.slack.example_dags.example_slack":[[0,1,1,"","slack_operator_file"]],"airflow.providers.slack.hooks":[[3,0,0,"-","slack"],[4,0,0,"-","slack_webhook"]],"airflow.providers.slack.hooks.slack":[[3,2,1,"","SlackHook"]],"airflow.providers.slack.hooks.slack.SlackHook":[[3,3,1,"","call"]],"airflow.providers.slack.hooks.slack_webhook":[[4,2,1,"","SlackWebhookHook"]],"airflow.providers.slack.hooks.slack_webhook.SlackWebhookHook":[[4,4,1,"","conn_name_attr"],[4,4,1,"","conn_type"],[4,4,1,"","default_conn_name"],[4,3,1,"","execute"],[4,4,1,"","hook_name"]],"airflow.providers.slack.operators":[[7,0,0,"-","slack"],[8,0,0,"-","slack_webhook"]],"airflow.providers.slack.operators.slack":[[7,2,1,"","SlackAPIFileOperator"],[7,2,1,"","SlackAPIOperator"],[7,2,1,"","SlackAPIPostOperator"]],"airflow.providers.slack.operators.slack.SlackAPIFileOperator":[[7,3,1,"","execute"],[7,4,1,"","template_fields"],[7,4,1,"","ui_color"]],"airflow.providers.slack.operators.slack.SlackAPIOperator":[[7,3,1,"","construct_api_call_params"],[7,3,1,"","execute"]],"airflow.providers.slack.operators.slack.SlackAPIPostOperator":[[7,3,1,"","construct_api_call_params"],[7,4,1,"","template_fields"],[7,4,1,"","ui_color"]],"airflow.providers.slack.operators.slack_webhook":[[8,2,1,"","SlackWebhookOperator"]],"airflow.providers.slack.operators.slack_webhook.SlackWebhookOperator":[[8,3,1,"","execute"],[8,4,1,"","template_fields"]]},objnames:{"0":["py","module","Python module"],"1":["py","data","Python data"],"2":["py","class","Python class"],"3":["py","method","Python method"],"4":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:data","2":"py:class","3":"py:method","4":"py:attribute"},terms:{"0":[0,1,2,3,4,5,6,7,8,10,12,13],"00642a46d0":9,"0080354502":9,"01":9,"0161b5ea2b":9,"02":9,"027b707d21":9,"03":9,"04":9,"05":9,"06":9,"07":9,"07c8ee0151":9,"08":9,"09":9,"0a0e1af800":9,"0a68588479":9,"0ac3b8c3dd":9,"0b0e4f7a4c":9,"0b2":9,"0beta1":9,"1":13,"10":[9,11],"10097":9,"10205":9,"10343ec29f":9,"10483":9,"10525":9,"10528":9,"10530":9,"10543":9,"10818":9,"10ed42a837":9,"11":[9,12],"11032":9,"11159":9,"11229":9,"11238":9,"11242":9,"11249":9,"11487":9,"11620":9,"11688":9,"11806":9,"11826":9,"11855":9,"12":[9,12],"12082":9,"12093":9,"12206":9,"12212":9,"12216":9,"12304":9,"12366":9,"12390":9,"12444":9,"12449":9,"12674":9,"12917":9,"12955":9,"12af6a0800":9,"12c5e5d8a":9,"13":9,"13148":9,"13380":9,"13717":9,"13745":[9,11],"13767":9,"14":9,"14013":9,"14082":9,"14289":[9,11],"14487":9,"14886":9,"14968":9,"15":9,"15499":9,"15518":9,"15576":9,"15667":[9,11],"15840":9,"16":9,"16109":[9,11],"16149":9,"16294":9,"16405":9,"16464":9,"16501":9,"16682":9,"16adc035b1":9,"16e7129719":9,"17":9,"17015":9,"17116":9,"17247":[9,11],"17400":[9,11],"17682":9,"17890":9,"18":9,"18466":[9,11],"18525":9,"18597":9,"18613":9,"18985":9,"19":9,"19321":9,"19882":9,"1e647029e4":9,"1fba5402bb":9,"2":[0,1,2,3,4,5,6,7,8,10,12,13],"20":9,"20061":9,"20190":9,"2020":9,"2021":[9,12,13],"2022":9,"20523":9,"20565":9,"20571":[9,11],"20614":9,"20951":9,"21":9,"21107":[9,11],"21257":9,"21439":9,"22":9,"22056":9,"22226":9,"22382":11,"22383":9,"23":9,"23rc1":9,"24":9,"24229":9,"24231":9,"24292":9,"25":9,"26":9,"27":9,"28":9,"2839450013":9,"29":9,"2935be1990":9,"2947e09999":9,"29493d2d61":9,"295d66f914":9,"2a1":9,"2f2d8dbfaf":9,"30":[3,9],"31":9,"32971a1a2d":9,"33f0cd2657":9,"349b0811c3":9,"3696c34c28":9,"375d1ca229":9,"37681bca00":9,"3fd5ef3555":9,"4":[0,1,2,3,4,5,6,7,8,10,12,13],"406f":12,"40a2476a5d":9,"41bf172c1d":9,"427257c2e2":9,"44bedf":7,"4543":9,"4830687453":9,"49":12,"4bde99f132":9,"4d3a":12,"4e8f9cc8d0":9,"4fb5c017fe":9,"5":[0,1,2,3,4,5,6,7,8,10,12,13],"512":12,"5220e4c384":9,"54":12,"5519":9,"578fc514cd":9,"589d6dec92":9,"59eb5de78c":9,"5a439e84eb":9,"5c6e":12,"5cf46fad1":9,"6":9,"602abe8394":9,"6644":9,"6646":9,"6674":12,"6714":9,"6889a333cf":9,"68e4c4dcb0":9,"6c3a67d4fc":9,"6cf76d7ac0":9,"6d9fc3ed98":9,"717a7588bc":9,"720912f67b":9,"7265":9,"7268":9,"7338":9,"76ed2a49c6":9,"7802":9,"7825e8f590":9,"7826":9,"7cc1c8bc00":9,"8":9,"807ad32ce5":9,"840ea3efb9":9,"853576d901":9,"85a18e13d9":9,"866a601b76":9,"872b1566a1":9,"87f408b1e7":9,"8807":9,"8886":9,"8891":9,"8898":9,"88bdcfa0df":9,"8982":9,"8994":9,"8b1":9,"8c060d55df":9,"8ec4":12,"9004":9,"9026":9,"92585ca4cb":9,"9320":9,"9370":9,"9404":9,"9408":9,"9460":9,"9549274d11":9,"9550":9,"97496ba2b4":9,"9784":9,"97a429f9d0":9,"9995":9,"9a04013b0":9,"9bf0ed2179":9,"9c94b72d44":9,"abstract":7,"boolean":3,"case":11,"class":[9,11],"default":[3,4,8,9],"do":12,"export":10,"final":9,"function":[7,9],"import":[9,11,12],"new":9,"return":[3,9,11],"static":[7,9],"super":9,"true":3,A:3,By:12,For:[3,9,10,11,12],If:[3,4,8,11,12],In:[7,11],It:[7,12],No:7,The:[3,4,7,8,10,11,12,13],There:12,To:12,a0821235fb:9,a47c58a780:9,a7ca1b3b0b:9,about:[9,12],abov:12,ac2f72c98d:9,accept:[9,11],access:3,actual:4,ad:[9,11],add:[9,11],addit:[7,9],advantag:3,ae7cb4a1e2:9,aeabe994b3:9,aeea71274d:9,after:9,aip:9,airflow:[12,13],airflow_conn_slack_default:10,aiyzngq:7,aka:12,all:[9,10,11],allow:[4,7,8,9,11],alreadi:12,also:[3,12],an:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],ani:[11,12],apach:[7,12],apache_airflow_providers_slack:12,api:[3,7,9,10,11],api_cal:3,api_call_param:7,api_method:3,api_param:7,append:3,appli:[9,11],apply_default:[9,11],ar:[3,11,12,13],arg:[3,4,9,11],argument:3,asc:[11,12],attach:[3,4,7,8],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:[3,4,7,8],base_url:[3,4,8],basehook:3,baseoper:7,bash:12,batch:9,bbc627a3da:9,be2b2baa7c:9,be75dcd39c:9,been:7,befor:7,belong:12,below:[11,12,13],bf2b48174a:9,bin:12,binari:12,black:9,blob:11,block:[3,4,7,8],bodi:3,bool:8,both:[3,4,8,13],branch:9,broken:9,bst:12,bugfix:9,buggfix:9,build:[9,12],c12318391:7,c34ef853c8:9,c42a375e79:9,c7e5bce57f:9,ca4238eb4d:9,call:[3,4,7,8,9,11],can:[3,4,8,11,12,13],candid:9,capit:9,cat:7,cbf8001d76:9,cde15c6e4d3a8ec4ecf4ba4b6674e08ad7de406f:12,cde1:12,cdec301254:9,certif:12,certifi:12,chang:9,changelog:9,channel:[3,4,7,8,13],chapter:12,chat:3,chat_postmessag:3,check:[3,7,9,12],checksum:[11,12],child:7,choos:12,classifi:[9,11],cleanup:9,client:3,client_arg:[3,7],code:[3,9,12],com:[3,7,11,12],come:9,command:9,comment:9,commit:9,compat:9,complet:[7,11],compon:10,configur:[4,8],conn_name_attr:4,conn_typ:4,connect:[3,4,7,8,9,11,13],construct:7,construct_api_call_param:7,constructor:9,contain:12,content:[9,13],context:[8,9],contributor:9,correct:[9,12],coverag:9,creat:[3,12],cross:9,curl:12,d0e7db4024:9,d1bce91bb2:9,d200:9,d202:9,d403:9,d56e7b56bb:9,d7dbfb7e26:9,d7de:12,d937bebdad:9,d94fa37830:9,d9567eb106:9,d:12,dad2f8103b:9,dag:[7,9,11,13],dag_id:13,data:[3,9],datetim:13,db:11,dd2095f4a8:9,decemb:9,decor:[9,11],default_arg:13,default_conn_nam:4,defunct:9,delai:9,demonstr:13,dep:12,depend:9,deriv:7,describ:12,descript:9,dest:12,detail:[3,7,9,11,12],dev0:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],dev:[3,9],df8efd04f3:9,dict:[3,7],dictionari:[3,4,8],diff:12,differ:12,directli:[3,4,8,11,13],directori:12,distribut:12,doc:[7,9],docstr:9,document:9,doesn:11,don:[9,11],doubl:9,down:12,download:12,drop:12,due:11,e08a:12,e:3,each:[4,7,8],ecf4:12,echo:12,ee7ca128a1:9,ef037e7021:9,either:13,emoji:[4,8],enabl:[9,10],encod:[3,10],endpoint:[4,8],environ:10,error:3,essenti:12,even:7,everywher:9,exampl:[3,7,9,10,11,12],example_dag:[5,13],example_slack:[1,5,13],execut:[3,4,7,8],exist:11,experiment:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],explain:11,explanatori:9,expos:3,express:9,extend:[9,11],extra:[7,8,9,11],f3521fb0e3:9,f3e87c5030:9,f5b96315fe:9,f6bd817a3a:9,f77417eb0d:9,f:9,fail:7,fals:[4,8],fdd9b6f65b:9,featur:[0,1,2,3,4,5,6,7,8,9,10,12,13],feb:9,ffba40:7,field:[3,4,7,8],file:[3,7,9,11,12],file_objectorfile_path:3,filenam:[7,9,11,13],filetyp:[7,13],find:[4,8],fingerprint:12,first:[9,11],fix:9,folder:12,follow:12,form:3,format:[7,9],formmatt:9,foundat:12,framework:11,fresh:9,friendli:[9,11],from:[3,7,9,11],futur:7,g:3,gener:[3,7,9,13],get:12,github:11,githubusercont:7,given:3,gmail:12,good:12,gpg:12,grammar:9,grpc:9,guid:[9,12],gz:12,ha:[3,4,7,8],handl:3,hash:9,have:[3,7,9,11],hello:[3,7,13],high:9,hook:[5,7,8,9,11],hook_nam:4,how:[9,11,12],html:3,http:[3,4,7,8,9,11,12],http_conn_id:[4,8],http_verb:3,httphook:4,i:12,icon:[4,7,8],icon_emoji:[4,8],icon_url:[4,7,8],id:[3,7,12,13],imag:[4,8],imageorfil:3,impement:9,implement:9,improv:9,includ:[3,9],incom:[4,8],increas:9,index:3,indic:12,individu:9,inform:9,initi:11,initial_com:[7,13],instal:9,install_requir:11,instanc:9,instead:[7,9],instruct:12,integr:[9,10],intellij:9,interact:9,introduc:9,issu:9,issuer:12,iter:3,its:7,j:7,januari:9,json:3,juli:9,june:9,k8:9,ka:12,kaxil:12,kaxilnaik:12,keep:9,kei:12,kit:7,know:12,kwarg:[3,4,7,8],l:12,la:12,latest:9,layout:7,lazili:9,least:11,left:12,level:9,librari:11,like:3,line:9,link:[4,8,9,12],link_nam:[4,8],list:[4,7,8,9,11],local:12,logo:9,ls:12,made:12,magic:9,mai:9,main:[7,9,11,12],make:[4,8,9,11],manag:[9,12],manual:11,march:9,markdown:9,match:[9,12],max_active_run:13,maximum:3,md:11,mean:11,messag:[3,4,7,8,13],meta:9,method:[3,7,9,11],might:11,migrat:11,min:9,minimum:11,mirror:12,misc:9,miss:9,mistakenli:11,mktemp:12,model:7,modul:9,month:9,more:[3,9],most:[11,12],move:9,multipart:3,multipl:9,mypi:[9,11],naik:12,name:[7,9,13],nativ:9,need:11,next:9,next_cursor:3,nhere:7,nhttp:7,noinspect:9,none:[3,4,7,8,12,13],note:[9,10,13],novemb:9,now:9,number:[3,9],o:12,octob:9,offici:12,onc:12,one:[7,12],onli:[7,11],oper:[5,9],optimis:11,option:[3,7,8,10],order:11,org:12,origin:12,otherwis:11,our:9,out:9,overrid:[4,7,8],owner:12,package_nam:12,package_vers:12,page:[9,12],param:3,paramet:[3,4,7,8,9],password:[3,4,7,9,10],path:[4,8],per:9,pgp:12,pgpk:12,pgpv:12,pin_100:7,pip:[9,11,12],place:[3,4,8],pleas:12,png:7,point:9,polici:11,pool:3,popen:4,post:[3,4,7,8],post_hello:7,postmessag:3,pre:[4,8],prepar:9,prevent:7,previou:12,primari:12,project:9,protocol:9,provid:[12,13],provider_download_dir:12,proxi:[4,8],py3:12,py:[9,13],pydocstyl:9,pylint:9,pypi:[9,11],python:[3,9,11,12],random:[3,7],raw:7,rc2:9,rc3:9,rc:9,readm:[9,11],receiv:3,recommend:12,ref:9,refer:7,refernc:9,regener:9,rel:[4,8],relas:9,releas:[9,11],relev:12,rema:9,remain:9,remot:4,remov:[9,11,12],renam:9,repo:9,repositori:11,repres:[3,4,8],request:3,requir:[3,7],respons:[3,7,9,11],rest:3,restor:[9,11],rsa:12,run:[11,12],s:[3,9,12],sat:12,schedule_interv:13,script:[9,12],sdist:[11,12],sdk:[3,11],second:3,see:[7,9,11],select:12,self:[3,4,7,8,12],send:[4,7,8],sensor:9,sent:7,sep:12,separ:9,septemb:9,sequenc:[7,8,9,11],server:[3,12],servic:9,set:7,setup:9,sha512:[11,12],sha:12,shasum:12,should:[3,4,7,8,10,12],sign:12,signatur:[9,11,12],simplehttpoper:8,simplifi:9,site:11,slack:12,slack_conn_id:[3,7,13],slack_default:[4,10],slack_example_dag:13,slack_file_upload_1:[7,13],slack_file_upload_2:[7,13],slack_hook:[3,9,11],slack_operator_fil:[0,7,13],slack_operator_file_cont:[7,13],slack_respons:3,slack_sdk:[3,9,11],slack_webhook:[2,5,6],slackapifileoper:[7,9,11,13],slackapioper:[7,10],slackapipostoper:[7,13],slackclient:9,slackhook:[3,7,9,10,11],slackrespons:3,slackwebhook:4,slackwebhookhook:[4,8,9],slackwebhookoper:8,softwar:12,sourc:[0,3,4,7,8,11,13],specif:[4,8,9],specifi:[3,10,11,13],sphinx:9,start_dat:[9,13],statu:9,step:12,str:[3,7,8],strict:9,string:[3,4,8,9],style:9,subject:9,subsequ:3,success:7,sum:12,suppli:[3,4,8],support:[9,11],synchron:9,syntax:10,t:[9,11],tag:13,take:[3,4,8],taken:[4,8],tar:12,target:3,task_id:[7,13],templat:7,template_field:[7,8,9,11],temporari:12,test:[7,13],text:[3,7,13],them:11,thi:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],those:[11,12],timeout:3,toc:9,token:[3,4,7,8,9,10,13],tool:9,toolchain:9,top:[11,12],transfer:9,trove:11,trust:12,txt:[7,13],type:[3,7,9,10,11],typehint:9,typo:9,ui_color:7,unknown:12,unsuccess:7,up:9,updat:[9,11],upgrad:[9,11],upload:[3,9,11],uri:10,url:[3,4,7,8,10],us:[3,4,7,8,9,10,11,12],use_sess:3,user:[4,8,12],usernam:[4,7,8],utf:9,v2:9,v3:[9,11],v:7,valid:12,valu:13,variabl:[9,10],verb:3,verifi:11,version:[9,11,12],via:[11,12],video:7,wait:3,want:[4,8,11,12],warn:[9,12],watch:7,wave:9,we:11,web:[3,7],webclient:[3,9],webhook:[4,8,9],webhook_token:[4,8],well:[7,12,13],wheel:11,when:[9,10,11],whether:[4,8],which:7,whl:12,why:12,word:9,world:[3,7,13],worri:12,wrong:9,wrongli:9,www:[3,7],xxx:[3,7],you:[3,4,8,10,11,12],your:[4,8,11],yourself:3,youtub:7},titles:["<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.slack.example_dags.example_slack</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.slack.example_dags</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.slack.hooks</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.slack.hooks.slack</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.slack.hooks.slack_webhook</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.slack</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.slack.operators</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.slack.operators.slack</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.slack.operators.slack_webhook</span></code>","Package apache-airflow-providers-slack","Slack Connection","<code class=\"docutils literal notranslate\"><span class=\"pre\">apache-airflow-providers-slack</span></code>","Installing from sources","How-to Guide for Slack Operators"],titleterms:{"0":[9,11],"1":[9,11],"2":[9,11],"3":[9,11],"4":[9,11],"5":[9,11],"break":11,"class":[3,4,7,8],"default":10,airflow:[0,1,2,3,4,5,6,7,8,9,11],apach:[9,11],authent:10,bug:11,chang:11,changelog:11,code:13,commit:11,configur:10,connect:10,content:[0,3,4,7,8,11],cross:11,depend:11,download:11,exampl:13,example_dag:[0,1],example_slack:0,featur:11,file:13,fix:11,from:12,guid:[11,13],hook:[2,3,4],how:13,id:10,instal:[11,12],integr:12,introduct:13,misc:11,modul:[0,3,4,7,8],offici:11,oper:[6,7,8,13],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,send:13,slack:[0,1,2,3,4,5,6,7,8,9,10,11,13],slack_webhook:[4,8],sourc:12,submodul:[1,2,6],subpackag:5,verifi:12}})