ensembl-hive  2.6
Bio::EnsEMBL::Hive::RunnableDB::SlackNotification Class Reference
+ Inheritance diagram for Bio::EnsEMBL::Hive::RunnableDB::SlackNotification:

Public Member Functions

public param_defaults ()
 
public run ()
 
- Public Member Functions inherited from Bio::EnsEMBL::Hive::Process
public new ()
 
public life_cycle ()
 
public say_with_header ()
 
public enter_status ()
 
public warning ()
 
public param_defaults ()
 
public fetch_input ()
 
public run ()
 
public write_output ()
 
public Bio::EnsEMBL::Hive::Worker worker ()
 
public execute_writes ()
 
public Bio::EnsEMBL::Hive::DBSQL::DBAdaptor db ()
 
public Bio::EnsEMBL::Hive::DBSQL::DBConnection dbc ()
 
public Bio::EnsEMBL::Hive::DBSQL::DBConnection data_dbc ()
 
public Returns run_system_command ()
 
public Bio::EnsEMBL::Hive::AnalysisJob input_job ()
 
public input_id ()
 
public param ()
 
public param_required ()
 
public param_exists ()
 
public param_is_defined ()
 
public param_substitute ()
 
public dataflow_output_id ()
 
public dataflow_output_ids_from_json ()
 
public throw ()
 
public This complete_early ()
 
public Int debug ()
 
public worker_temp_directory ()
 
public cleanup_worker_temp_directory ()
 

Detailed Description

Synopsis

This is a RunnableDB module that implements Bio::EnsEMBL::Hive::Process interface
and is ran by Workers during the execution of eHive pipelines.
It is not generally supposed to be instantiated and used outside of this framework.
Please refer to Bio::EnsEMBL::Hive::Process documentation to understand the basics of the RunnableDB interface.
Please refer to Bio::EnsEMBL::Hive::PipeConfig::* pipeline configuration files to understand how to configure pipelines.

Description

    This RunnableDB module will send a notification to a Slack channel.
    You can either dataflow into it, or simply create standalone jobs.

    It requires "slack_webhook" to be defined. You can this in the parameters of your Slack team.
    The message itself is defined by the "text" parameter (and optionally by "attachments" too).

Definition at line 27 of file SlackNotification.pm.

Member Function Documentation

◆ param_defaults()

public Bio::EnsEMBL::Hive::RunnableDB::SlackNotification::param_defaults ( )

Undocumented method

Code:
click to view

◆ run()

public Bio::EnsEMBL::Hive::RunnableDB::SlackNotification::run ( )

Undocumented method

Code:
click to view

The documentation for this class was generated from the following file:
Bio::EnsEMBL::Hive::RunnableDB::SlackNotification::run
public run()
Bio::EnsEMBL::Hive::Process
Definition: Process.pm:77
Bio::EnsEMBL::Hive::PipeConfig
Definition: EnsemblGeneric_conf.pm:5
Bio::EnsEMBL::Hive::RunnableDB::SlackNotification::param_defaults
public param_defaults()