com.netflix.spinnaker.echo.api.Notification.groovy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of echo-notifications Show documentation
Spinnaker Echo
The newest version!
/*
 * Copyright 2015 Netflix, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.netflix.spinnaker.echo.api

import com.fasterxml.jackson.annotation.JsonSubTypes
import com.fasterxml.jackson.annotation.JsonTypeInfo
import groovy.transform.Canonical

class Notification {
  String notificationType
  Collection to
  Collection cc
  String templateGroup
  Severity severity
  Source source
  Map additionalContext = [:]
  InteractiveActions interactiveActions
  Boolean useInteractiveBot = false

  boolean isInteractive() {
    useInteractiveBot || (interactiveActions != null && !interactiveActions.actions.empty)
  }

  static class Source {
    String executionType
    String executionId
    String application
    String user
  }

  static enum Severity {
    NORMAL,
    HIGH
  }

  /**
   * Allows Spinnaker services sending Notifications through Echo to specify one or more interactive actions
   * that, when acted upon by a user, cause a callback to Echo which gets routed to that originating service.
   */
  static class InteractiveActions {
    String callbackServiceId
    String callbackMessageId
    String color = '#cccccc'
    List actions = []
  }

  @JsonTypeInfo(
    include = JsonTypeInfo.As.EXISTING_PROPERTY,
    use = JsonTypeInfo.Id.NAME,
    property = "type")
  @JsonSubTypes(
    @JsonSubTypes.Type(value = ButtonAction.class, name = "button")
  )
  abstract static class InteractiveAction {
    String type
    String name
    String value
  }

  @Canonical
  static class ButtonAction extends InteractiveAction {
    String type = "button"
    String label
  }

  @Canonical
  static class InteractiveActionCallback {
    InteractiveAction actionPerformed
    String serviceId
    String messageId
    String user
  }
}