models

Type Members

1. sealed trait Aggregator extends AnyRef

   

   An aggregator for metric data

2. case class Alert(id: Option[String] = None, description: String, enabled: Boolean, period: String, condition: String, handbookUrl: Option[String] = None, routing: Option[Map[String, String]] = None, relatedMetrics: Option[Seq[AlertMetric]] = None) extends Product with Serializable

   

   This entity describes a configured alert, what to check and how often.

3. case class AlertMetric(name: String, tags: Map[String, String], aggregator: Option[Aggregator] = None, periodSeconds: Option[Long] = None) extends Product with Serializable

   

   Information about a metric related to an alert.

4. case class Auth(token: String, expires: DateTime) extends Product with Serializable

   

   Authorization information for a user

5. case class Issue(description: String, since: DateTime, until: Option[DateTime] = None) extends Product with Serializable

   

   An issue affecting CAVE right now, or recently closed

6. case class Member(user: User, role: Role) extends Product with Serializable

   

   An organization or team user, with the role

7. case class Metric(name: String, tags: Option[Map[String, String]] = None, timestamp: Long, value: Double) extends Product with Serializable

   

   This entity encapsulates metric data that can be stored in CAVE.

8. case class MetricData(time: DateTime, value: Double) extends Product with Serializable

   

   This entity encapsulates a data point for a metric.

9. case class MetricDataBulk(metrics: Seq[MetricData]) extends Product with Serializable

   

   This entity encapsulates data for a metric.

10. case class MetricInfo(name: String, tags: Seq[String]) extends Product with Serializable

    

    This entity encapsulates information about a metric.

11. case class Organization(name: String, email: String, notificationUrl: String, tokens: Seq[Token]) extends Product with Serializable

    

    An organization is a real-world customer of the CAVE service.

    An organization is a real-world customer of the CAVE service. Each organization is identified by a name, which must be unique. Each organization can have one or more teams associated with it, allowing for data to be segregated. Security is managed with organization tokens. A token is created automatically for every new organization.

12. sealed trait Role extends AnyRef

    

    The role that a user has in an organization or team

13. case class Status(current: Seq[Issue], recent: Seq[Issue]) extends Product with Serializable

    

    The list of current and recent issues affecting CAVE

14. case class Team(name: String, tokens: Seq[Token]) extends Product with Serializable

    

    Each team has its own data.

    Each team has its own data. A team can push data into CAVE by using an active token. A team can have one or more tokens associated with it, allowing for tokens to be rotated, for security purposes. A team is solely responsible for administration of its tokens. A team token is created automatically for every new team.

15. case class Token(id: String, description: String, value: String, created: DateTime) extends Product with Serializable

    

    A token is a security string, used to authenticate requests.

    A token is a security string, used to authenticate requests. Some requests can only be executed by the organization owner, and these must be authenticated with an organization token. Other requests can only be executed by a team owner, and these can be authenticated with either a team token, or an organization token.

16. case class User(firstName: String, lastName: String, email: String) extends Product with Serializable

    

    A user is a real-world person who is using the CAVE service.

    A user is a real-world person who is using the CAVE service. The user signs up for CAVE, and then interacts with the service through the APIs. Every call to the API needs to use a token that is obtained after a successful login.

17. case class UserOrganization(name: String, role: Role) extends Product with Serializable

    

    An organization associated with a user.

18. case class UserTeam(name: String, role: Role) extends Product with Serializable

    

    A team associated with a user.