org.jenkinsci.plugins.githubautostatus.notifiers

Interface BuildNotifier

All Known Implementing Classes:

GithubBuildNotifier, InfluxDbNotifier

public interface BuildNotifier

A notification subscriber which can send build stats to a particular sink.

Author:

Jeff Pearce (jxpearce@godaddy.com)

Method Summary

Modifier and Type	Method and Description
boolean	isEnabled() Determine whether notifier is enabled.
void	notifyBuildStageStatus(String jobName, String nodeName, BuildState buildState, long nodeDuration) Send a state change with timing info
void	notifyBuildState(String jobName, String nodeName, BuildState buildState) Send a state change, such as from Pending to Success or Pending to Error.
void	notifyFinalBuildStatus(String jobName, BuildState buildState, long buildDuration, long blockedDuration) Send a notification when the job is complete
void	sendNonStageError(String jobName, String nodeName) Sends a notification for an error regardless of whether initial pending status was sent.

Method Detail

isEnabled

boolean isEnabled()

Determine whether notifier is enabled.

Returns:

true if enabled; false otherwise.

notifyBuildState

void notifyBuildState(String jobName,
                      String nodeName,
                      BuildState buildState)

Send a state change, such as from Pending to Success or Pending to Error.

Parameters:

jobName - the name of the job.

nodeName - the node that has changed.

buildState - the new state.

notifyBuildStageStatus

void notifyBuildStageStatus(String jobName,
                            String nodeName,
                            BuildState buildState,
                            long nodeDuration)

Send a state change with timing info

Parameters:

jobName - the name of the job

nodeName - the node that has changed

buildState - the new state

nodeDuration - elapsed time for this node

notifyFinalBuildStatus

void notifyFinalBuildStatus(String jobName,
                            BuildState buildState,
                            long buildDuration,
                            long blockedDuration)

Send a notification when the job is complete

Parameters:

jobName - the name of the job

buildState - state indicating success or failure

buildDuration - the build duration

blockedDuration - time build was blocked before running

sendNonStageError

void sendNonStageError(String jobName,
                       String nodeName)

Sends a notification for an error regardless of whether initial pending status was sent. Useful for reporting errors for non-declarative pipelines since they can happen outside of a stage.

Parameters:

jobName - the name of the job

nodeName - the name of the node that failed