Package com.netflix.spinnaker.echo.api.events

Interface NotificationAgent

All Superinterfaces:

org.pf4j.ExtensionPoint, com.netflix.spinnaker.kork.plugins.api.internal.SpinnakerExtensionPoint

@Alpha
public interface NotificationAgent
extends com.netflix.spinnaker.kork.plugins.api.internal.SpinnakerExtensionPoint

A NotificationAgent handles user-configured pipeline notifications.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	NotificationAgent.NotificationUIType

Method Summary

Modifier and Type	Method	Description
String	getNotificationType()	The notification's type (e.g., Slack, SMS, email).
List<NotificationParameter>	getParameters()	Notification parameter definitions.
default NotificationAgent.NotificationUIType	getUiType()	Return BASIC here to auto-generate a UI from the parameters defined in Notification#getParameters.
void	sendNotifications(Map<String,Object> notificationConfig, String application, Event event, String status)

Methods inherited from interface com.netflix.spinnaker.kork.plugins.api.internal.SpinnakerExtensionPoint

getExtensionClass, getPluginId

Method Details

getNotificationType

@Nonnull
String getNotificationType()

The notification's type (e.g., Slack, SMS, email).

sendNotifications

void sendNotifications(@Nonnull
 Map<String,Object> notificationConfig,
 @Nonnull
 String application,
 @Nonnull
 Event event,
 @Nonnull
 String status)

Parameters:

notificationConfig - - User-defined configuration. Arbitrary key-value pairs can be passed to the agent here (e.g., a Slack channel name).

application - - The name of the application where the pipeline was run.

event - - a Spinnaker Event.

status - - The state of the referenced resource (e.g., failed, complete, etc.).

getParameters

@Nonnull
List<NotificationParameter> getParameters()

Notification parameter definitions. Users set these values via Spinnaker's UI; the parameters will be passed through sendNotifications(java.util.Map<java.lang.String, java.lang.Object>, java.lang.String, com.netflix.spinnaker.echo.api.events.Event, java.lang.String) as key-value pairs.

getUiType

@Nonnull
default NotificationAgent.NotificationUIType getUiType()

Return BASIC here to auto-generate a UI from the parameters defined in Notification#getParameters. Return CUSTOM to use a custom UI instead.