blob: ae9fad3e14b52c3de404dd93b3e6d56b2d9af353 [file] [log] [blame]
Search.setIndex({docnames:["_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":4,"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/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":[[3,0,0,"-","slack"]],"airflow.providers.slack":[[0,0,0,"-","hooks"],[4,0,0,"-","operators"]],"airflow.providers.slack.hooks":[[1,0,0,"-","slack"],[2,0,0,"-","slack_webhook"]],"airflow.providers.slack.hooks.slack":[[1,1,1,"","SlackHook"]],"airflow.providers.slack.hooks.slack.SlackHook":[[1,2,1,"","call"]],"airflow.providers.slack.hooks.slack_webhook":[[2,1,1,"","SlackWebhookHook"]],"airflow.providers.slack.hooks.slack_webhook.SlackWebhookHook":[[2,3,1,"","conn_name_attr"],[2,3,1,"","conn_type"],[2,3,1,"","default_conn_name"],[2,2,1,"","execute"],[2,3,1,"","hook_name"]],"airflow.providers.slack.operators":[[5,0,0,"-","slack"],[6,0,0,"-","slack_webhook"]],"airflow.providers.slack.operators.slack":[[5,1,1,"","SlackAPIFileOperator"],[5,1,1,"","SlackAPIOperator"],[5,1,1,"","SlackAPIPostOperator"]],"airflow.providers.slack.operators.slack.SlackAPIFileOperator":[[5,2,1,"","execute"],[5,3,1,"","template_fields"],[5,3,1,"","ui_color"]],"airflow.providers.slack.operators.slack.SlackAPIOperator":[[5,2,1,"","construct_api_call_params"],[5,2,1,"","execute"]],"airflow.providers.slack.operators.slack.SlackAPIPostOperator":[[5,2,1,"","construct_api_call_params"],[5,3,1,"","template_fields"],[5,3,1,"","ui_color"]],"airflow.providers.slack.operators.slack_webhook":[[6,1,1,"","SlackWebhookOperator"]],"airflow.providers.slack.operators.slack_webhook.SlackWebhookOperator":[[6,2,1,"","execute"],[6,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],"00642a46d":7,"008035450":7,"01":7,"0161b5ea2":7,"02":7,"03":7,"04":7,"05":7,"06":7,"07":7,"07c8ee015":7,"08":7,"09":7,"0a0e1af80":7,"0a6858847":7,"0ac3b8c3d":7,"0b0e4f7a4":7,"0b2":7,"0beta1":7,"1":11,"10":7,"10097":7,"10205":7,"10343ec29":7,"10483":7,"10525":7,"10528":7,"10530":7,"10543":7,"10818":7,"10ed42a83":7,"11":[7,10],"11032":7,"11159":7,"11229":7,"11238":7,"11242":7,"11249":7,"11487":7,"11620":7,"11688":7,"11806":7,"11826":7,"11855":7,"12":[7,10],"12082":7,"12093":7,"12206":7,"12212":7,"12216":7,"12304":7,"12366":7,"12390":7,"12444":7,"12449":7,"12674":7,"12917":7,"12955":7,"12af6a080":7,"12c5e5d8a":7,"13":7,"13148":7,"13380":7,"13717":7,"13745":[7,9],"13767":7,"14":7,"14013":7,"14082":7,"14289":[7,9],"14487":7,"14886":7,"14968":7,"15":7,"15499":7,"15518":7,"15576":7,"15667":[7,9],"15840":7,"16":7,"16109":[7,9],"16149":7,"16294":7,"16405":7,"16464":7,"16501":7,"16682":7,"16e712971":7,"17":7,"17015":7,"17116":7,"17247":[7,9],"17400":[7,9],"17682":7,"17890":7,"18":7,"18466":[7,9],"18525":7,"18597":7,"18613":7,"18985":7,"19":7,"19321":7,"19882":7,"1e647029":7,"1fba5402b":7,"2":[0,1,2,3,4,5,6,8,10,11],"20":7,"20061":7,"20190":7,"2020":7,"2021":[7,10,11],"2022":7,"20523":7,"20565":7,"20571":[7,9],"20614":7,"20951":7,"21":7,"21107":[7,9],"21257":7,"22":7,"23":7,"23rc1":7,"24":7,"25":7,"26":7,"27":7,"28":7,"283945001":7,"29":7,"2935be199":7,"2947e0999":7,"29493d2d6":7,"295d66f91":7,"2a1":7,"2f2d8dbfa":7,"3":[0,1,2,3,4,5,6,8,10,11],"30":[1,7],"31":7,"32971a1a2":7,"33f0cd265":7,"349b0811c":7,"3696c34c2":7,"375d1ca22":7,"37681bca0":7,"3fd5ef355":7,"4":[0,1,2,3,4,5,6,8,10,11],"406f":10,"40a2476a5":7,"41bf172c1":7,"427257c2e":7,"44bedf":5,"4543":7,"483068745":7,"49":10,"4bde99f13":7,"4d3a":10,"4e8f9cc8d":7,"4fb5c017f":7,"512":10,"5220e4c38":7,"54":10,"5519":7,"578fc514c":7,"589d6dec9":7,"59eb5de78":7,"5a439e84":7,"5c6e":10,"5cf46fad1":7,"6":7,"602abe839":7,"6644":7,"6646":7,"6674":10,"6714":7,"6889a333c":7,"68e4c4dcb":7,"6c3a67d4f":7,"6cf76d7ac":7,"6d9fc3ed9":7,"720912f67":7,"7265":7,"7268":7,"7338":7,"76ed2a49c":7,"7802":7,"7825e8f59":7,"7826":7,"7cc1c8bc0":7,"8":7,"807ad32c":7,"840ea3efb":7,"853576d90":7,"85a18e13d":7,"866a601b7":7,"872b1566a":7,"87f408b1e":7,"8807":7,"8886":7,"8891":7,"8898":7,"88bdcfa0d":7,"8982":7,"8994":7,"8b1":7,"8c060d55d":7,"8ec4":10,"9004":7,"9026":7,"92585ca4c":7,"9320":7,"9370":7,"9404":7,"9408":7,"9460":7,"9549274d1":7,"9550":7,"97496ba2b":7,"9784":7,"97a429f9d":7,"9995":7,"9a04013b0":7,"9bf0ed217":7,"9c94b72d4":7,"abstract":5,"boolean":1,"case":9,"class":[7,9],"default":[1,2,6,7],"do":10,"export":8,"final":7,"function":[5,7],"import":[7,9,10],"new":7,"return":[1,7,9],"static":[5,7],"super":7,"true":1,A:1,By:10,For:[1,7,8,9,10],If:[1,2,6,9,10],In:[5,9],It:[5,10],No:5,The:[1,2,5,6,8,9,10,11],There:10,To:10,a0821235f:7,a47c58a78:7,a7ca1b3b0:7,about:[7,10],abov:10,ac2f72c98:7,accept:[7,9],access:1,actual:2,ad:7,add:7,addit:[5,7],advantag:1,ae7cb4a1:7,aeea71274:7,after:7,aip:7,airflow:[10,11],airflow_conn_slack_default:8,aiyzngq:5,aka:10,all:[7,8,9],allow:[2,5,6,7,9],alreadi:10,also:[1,10],an:[0,1,2,3,4,5,6,7,8,9,10,11],ani:[9,10],apach:[5,10],apache_airflow_providers_slack:10,api:[1,5,7,8,9],api_cal:1,api_call_param:5,api_method:1,api_param:5,append:1,appli:[7,9],apply_default:[7,9],ar:[1,9,10,11],arg:[1,2,7,9],argument:1,asc:[9,10],attach:[1,2,5,6],august:7,auto:[7,9],autoapi:7,autom:7,automat:9,avail:10,b2a28d159:7,b40dffa08:7,b916b7507:7,ba4b:10,backport:7,base:[1,2,5,6],base_url:[1,2,6],basehook:1,baseoper:5,bash:10,batch:7,bbc627a3d:7,be2b2baa7:7,be75dcd39:7,been:5,befor:5,belong:10,below:[10,11],bf2b48174:7,bin:10,binari:10,black:7,block:[1,2,5,6],bodi:1,bool:6,both:[1,2,6,11],branch:7,broken:7,bst:10,buggfix:7,build:[7,10],c12318391:5,c34ef853c:7,c42a375e7:7,c7e5bce57:7,ca4238eb4:7,call:[1,2,5,6,7,9],can:[1,2,6,9,10,11],candid:7,capit:7,cat:5,cbf8001d7:7,cde15c6e4d3a8ec4ecf4ba4b6674e08ad7de406f:10,cde1:10,cdec30125:7,certif:10,certifi:10,chang:7,changelog:7,channel:[1,2,5,6,11],chapter:10,chat:1,chat_postmessag:1,check:[1,5,7,10],checksum:[9,10],child:5,choos:10,cleanup:7,client:1,client_arg:[1,5],code:[1,7,10],com:[1,5,10],come:7,command:7,comment:7,commit:7,compat:7,complet:[5,9],compon:8,configur:[2,6],conn_name_attr:2,conn_typ:2,connect:[1,2,5,6,7,9,11],construct:5,construct_api_call_param:5,constructor:7,contain:10,content:[7,11],context:[6,7],correct:[7,10],coverag:7,creat:[1,10],cross:7,curl:10,d0e7db402:7,d1bce91bb:7,d200:7,d202:7,d403:7,d56e7b56b:7,d7de:10,d937bebda:7,d9567eb10:7,d:10,dad2f8103:7,dag:[5,7,9,11],dag_id:11,data:[1,7],datetim:11,db:9,dd2095f4a:7,decemb:7,decor:[7,9],default_arg:11,default_conn_nam:2,defunct:7,demonstr:11,dep:10,depend:7,deriv:5,describ:10,descript:7,dest:10,detail:[1,5,7,9,10],dev0:[0,1,2,3,4,5,6,7,8,9,10,11],dev:[1,7],df8efd04f:7,dict:[1,5],dictionari:[1,2,6],diff:10,differ:10,directli:[1,2,6,9,11],directori:10,distribut:10,doc:[5,7],docstr:7,document:7,doesn:9,don:[7,9],down:10,download:10,drop:10,due:9,e08a:10,e:1,each:[2,5,6],ecf4:10,echo:10,ee7ca128a:7,ef037e702:7,either:11,emoji:[2,6],enabl:[7,8],encod:[1,8],endpoint:[2,6],environ:8,error:1,essenti:10,even:5,everywher:7,exampl:[1,5,7,8,9,10],example_dag:11,example_slack:11,execut:[1,2,5,6],exist:9,experiment:[0,1,2,3,4,5,6,7,8,9,10,11],expos:1,express:7,extend:[7,9],extra:[5,6,7,9],f3521fb0e:7,f3e87c503:7,f6bd817a3:7,f77417eb0:7,f:7,fail:5,fals:[2,6],fdd9b6f65:7,featur:[0,1,2,3,4,5,6,7,8,10,11],ffba40:5,field:[1,2,5,6],file:[1,5,7,9,10],file_objectorfile_path:1,filenam:[5,7,9,11],filetyp:[5,11],find:[2,6],fingerprint:10,first:[7,9],fix:7,folder:10,follow:10,form:1,format:[5,7],formmatt:7,foundat:10,fresh:7,friendli:[7,9],from:[1,5,7,9],futur:5,g:1,gener:[1,5,7,11],get:10,githubusercont:5,given:1,gmail:10,good:10,gpg:10,grammar:7,grpc:7,guid:[7,10],gz:10,ha:[1,2,5,6],handl:1,hash:7,have:[1,5,7,9],hello:[1,5,11],high:7,hook:[3,5,6,7,9],hook_nam:2,how:[7,9,10],html:1,http:[1,2,5,6,7,9,10],http_conn_id:[2,6],http_verb:1,httphook:2,i:10,icon:[2,5,6],icon_emoji:[2,6],icon_url:[2,5,6],id:[1,5,10,11],imag:[2,6],imageorfil:1,impement:7,implement:7,improv:7,includ:[1,7],incom:[2,6],increas:7,index:1,indic:10,individu:7,inform:7,initi:9,initial_com:[5,11],instal:7,instanc:7,instead:[5,7],instruct:10,integr:[7,8],intellij:7,interact:7,introduc:7,issu:7,issuer:10,iter:1,its:5,j:5,januari:7,json:1,juli:7,june:7,k8:7,ka:10,kaxil:10,kaxilnaik:10,keep:7,kei:10,kit:5,know:10,kwarg:[1,2,5,6],l:10,la:10,latest:7,layout:5,lazili:7,least:9,left:10,level:7,librari:9,like:1,line:7,link:[2,6,7,10],link_nam:[2,6],list:[2,5,6,7,9],local:10,logo:7,ls:10,made:10,magic:7,main:[5,7,10],make:[2,6,7,9],manag:[7,10],manual:9,markdown:7,match:[7,10],max_active_run:11,maximum:1,mean:9,messag:[1,2,5,6,11],meta:7,method:[1,5,7,9],might:9,migrat:9,mirror:10,misc:7,miss:7,mktemp:10,model:5,modul:7,month:7,more:[1,7],most:[9,10],move:7,multipart:1,multipl:7,mypi:[7,9],naik:10,name:[5,7,11],nativ:7,need:9,next:7,next_cursor:1,nhere:5,nhttp:5,noinspect:7,none:[1,2,5,6,10,11],note:[7,8,11],novemb:7,now:7,number:[1,7],o:10,octob:7,offici:10,onc:10,one:[5,10],onli:5,oper:[3,7],optimis:9,option:[1,5,6,8],order:9,org:10,origin:10,otherwis:9,our:7,out:7,overrid:[2,5,6],owner:10,package_nam:10,package_vers:10,page:[7,10],param:1,paramet:[1,2,5,6,7],password:[1,2,5,7,8],path:[2,6],per:7,pgp:10,pgpk:10,pgpv:10,pin_100:5,pip:[7,10],place:[1,2,6],pleas:10,png:5,point:7,pool:1,popen:2,post:[1,2,5,6],post_hello:5,postmessag:1,pre:[2,6],prepar:7,prevent:5,previou:10,primari:10,project:7,protocol:7,provid:[10,11],provider_download_dir:10,proxi:[2,6],py3:10,py:[7,11],pydocstyl:7,pylint:7,pypi:[7,9],python:[1,7,9,10],random:[1,5],raw:5,rc2:7,rc3:7,rc:7,readm:7,receiv:1,recommend:10,ref:7,refer:5,refernc:7,regener:7,rel:[2,6],relas:7,releas:[7,9],relev:10,rema:7,remain:7,remot:2,remov:[7,9,10],renam:7,repo:7,repositori:9,repres:[1,2,6],request:1,requir:[1,5],respons:[1,5,7,9],rest:1,restor:[7,9],rsa:10,run:[9,10],s:[1,7,10],sat:10,schedule_interv:11,script:[7,10],sdist:[9,10],sdk:[1,9],second:1,see:[5,7,9],select:10,self:[1,2,5,6,10],send:[2,5,6],sensor:7,sent:5,sep:10,separ:7,septemb:7,sequenc:[5,6,7,9],server:[1,10],servic:7,set:5,setup:7,sha512:[9,10],sha:10,shasum:10,should:[1,2,5,6,8,10],sign:10,signatur:[7,9,10],simplehttpoper:6,simplifi:7,site:9,slack:10,slack_conn_id:[1,5,11],slack_default:[2,8],slack_example_dag:11,slack_file_upload_1:[5,11],slack_file_upload_2:[5,11],slack_hook:[1,7,9],slack_operator_fil:[5,11],slack_operator_file_cont:[5,11],slack_respons:1,slack_sdk:[1,7,9],slack_webhook:[0,3,4],slackapifileoper:[5,7,9,11],slackapioper:[5,8],slackapipostoper:[5,11],slackclient:7,slackhook:[1,5,7,8,9],slackrespons:1,slackwebhook:2,slackwebhookhook:[2,6,7],slackwebhookoper:6,softwar:10,sourc:[1,2,5,6,9,11],specif:[2,6],specifi:[1,8,9,11],sphinx:7,start_dat:[7,11],statu:7,step:10,str:[1,5,6],strict:7,string:[1,2,6,7],style:7,subject:7,subsequ:1,success:5,sum:10,suppli:[1,2,6],support:[7,9],synchron:7,syntax:8,t:[7,9],tag:11,take:[1,2,6],taken:[2,6],tar:10,target:1,task_id:[5,11],templat:5,template_field:[5,6,7,9],temporari:10,test:[5,11],text:[1,5,11],them:9,thi:[0,1,2,3,4,5,6,7,8,9,10,11],those:[9,10],timeout:1,toc:7,token:[1,2,5,6,7,8,11],tool:7,toolchain:7,top:[9,10],transfer:7,trust:10,txt:[5,11],type:[1,5,7,8,9],typehint:7,typo:7,ui_color:5,unknown:10,unsuccess:5,up:7,updat:[7,9],upgrad:[7,9],upload:[1,7,9],uri:8,url:[1,2,5,6,8],us:[1,2,5,6,7,8,9,10],use_sess:1,user:[2,6,10],usernam:[2,5,6],utf:7,v2:7,v3:[7,9],v:5,valid:10,valu:11,variabl:[7,8],verb:1,verifi:9,version:[7,9,10],via:[9,10],video:5,wait:1,want:[2,6,9,10],warn:[7,10],watch:5,wave:7,we:9,web:[1,5],webclient:[1,7],webhook:[2,6,7],webhook_token:[2,6],well:[5,10,11],wheel:9,when:[7,8,9],whether:[2,6],which:5,whl:10,why:10,word:7,world:[1,5,11],worri:10,wrong:7,wrongli:7,www:[1,5],xxx:[1,5],you:[1,2,6,8,9,10],your:[2,6,9],yourself:1,youtub:5},titles:["<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":[7,9],"1":[7,9],"2":[7,9],"3":[7,9],"4":[7,9],"break":9,"class":[1,2,5,6],"default":8,airflow:[0,1,2,3,4,5,6,7,9],apach:[7,9],authent:8,bug:9,chang:9,changelog:9,code:11,commit:9,configur:8,connect:8,content:[1,2,5,6,9],cross:9,depend:9,download:9,exampl:11,featur:9,file:11,fix:9,from:10,guid:[9,11],hook:[0,1,2],how:11,id:8,instal:[9,10],integr:10,introduct:11,misc:9,modul:[1,2,5,6],offici:9,oper:[4,5,6,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,send:11,slack:[0,1,2,3,4,5,6,7,8,9,11],slack_webhook:[2,6],sourc:10,submodul:[0,4],subpackag:3,verifi:10}})