Packages

package core

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. core
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class Board [B <: HList](title: String, boxes: B, aggregate: (Map[Box[_], View], Context) ⇒ View, layout: Layout, links: Seq[(Box[_], Box[_])] = Seq.empty, slo: Double = 0.97)(implicit constraint: UnaryTCConstraint[B, Box], boxSet: Aux[B, Set, Box[_]]) extends Product with Serializable

    Top level component

    Top level component

    title

    The board title

    boxes

    The children boxes

    aggregate

    Aggregates its children boxes views

    layout

    The layout of the board

    links

    Defines links between boxes, will draw lines in the UI

    slo

    Defines the SLO threshold for the calendar.

  2. case class Box [T](title: String, checks: Seq[Check[T]], aggregate: (Map[Check[T], CheckResult[T]], Context) ⇒ View, description: Option[String] = None, labelLimit: Option[Int] = None) extends Product with Serializable

    A box that groups checks

    A box that groups checks

    T

    The type bound to the checks

    title

    The title

    checks

    The checks

    aggregate

    Aggregates the views of its checks, return a view

    description

    The description of the box in markdown syntax

    labelLimit

    The limit of visible check labels shown on the box

  3. case class Check [T](id: String, title: String, apply: () ⇒ Future[T], display: (T, Context) ⇒ View) extends Product with Serializable

    Basic unit for declaring a metric to check

    Basic unit for declaring a metric to check

    T

    The type of values to be checked

    id

    The identifier

    title

    The title of the check

    apply

    A function when called, should return a future of target value

    display

    A function that takes a checked value and a Context

  4. case class CheckResult [T](view: View, value: Option[T]) extends Product with Serializable

    Represents the result of a check

    Represents the result of a check

    T

    The checked value type

    view

    The view of the check

    value

    The value of the check

  5. trait Codec [T, Repr] extends AnyRef

    Codec for values to be put in a store

    Codec for values to be put in a store

    T

    Input type

    Repr

    Encoded type

  6. case class Column (percentage: Double, rows: Row*) extends Product with Serializable

    Represents a column on a board

    Represents a column on a board

    percentage

    The percentage it takes as width

    rows

    The rows in the column

  7. case class Context (when: Instant) extends Product with Serializable

    Represents the context when a check occurs

    Represents the context when a check occurs

    when

    The datetime when it occurs

  8. case class Layout (columns: Column*) extends Product with Serializable

    Defines the layout of a board

    Defines the layout of a board

    columns

    List of Column

  9. case class Row (title: String, percentage: Double = 100, boxes: Seq[Box[_]]) extends Product with Serializable

    Represents a row inside a column

    Represents a row inside a column

    title

    The title

    percentage

    The percentage it takes as height, defaults to 100

    boxes

    The boxes to be displayed in the row

  10. sealed class Status extends Ordered[Status]

    The status of a check

  11. trait Store [Repr] extends AnyRef

    Persists checked values

    Persists checked values

    Repr

    Persistent data type in the store

  12. case class View (status: Status, message: String, label: Option[String] = None) extends Product with Serializable

    A view represents the status of a given check

    A view represents the status of a given check

    status

    The status of the underlying check

    message

    The message to show

    label

    The label

Value Members

  1. def HNil: shapeless.HNil.type
  2. object Box extends Serializable
  3. object Context extends Serializable
  4. object Layout extends Serializable
  5. object Status
  6. object View extends Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped