Stream Events¶

interface StreamEventsRequest {

  // Filter the lower bound of the event's generation time. Specify a date
  // string in ISO 8601 format.
  start: string;  // RFC 3339 timestamp

  // Filter the upper bound of the event's generation time. Specify a date
  // string in ISO 8601 format.
  stop: string;  // RFC 3339 timestamp

  // Event sources to include. Leave unset, to include all.
  source: string[];

  // Filter on minimum severity level
  severity: string;

  // Search by text
  q: string;

  // Filter query. See {doc}`../filtering` for how to write a filter query.
  //
  // Literal text search matches against the `message`, `source` and `type`
  // fields. Field comparisons can use any of the following fields:
  //
  // | Field       | Type   | Description                        |
  // | ----------- | ------ | ---------------------------------- |
  // | `message`   | string | Filter by message text             |
  // | `seqNumber` | number | Filter by archived sequence number |
  // | `severity`  | enum   | Filter by event severity           |
  // | `source`    | string | Filter by event source             |
  // | `type`      | string | Filter by event type               |
  //
  // Possible severities: `info`, `watch`, `warning`, `distress`, `critical`
  // or `severe`.
  filter: string;
}

interface Event {
  source: string;
  generationTime: string;  // RFC 3339 timestamp
  receptionTime: string;  // RFC 3339 timestamp
  seqNumber: number;
  type: string;
  message: string;
  severity: EventSeverity;

  // Set by API when event was posted by a user
  createdBy: string;

  // Additional properties
  extra: {[key: string]: string};
}

enum EventSeverity {
  INFO = "INFO",
  WARNING = "WARNING",

  // Legacy, avoid use.
  ERROR = "ERROR",
  WATCH = "WATCH",

  // Placeholder for future WARNING constant.
  // (correctly sorted between WATCH and DISTRESS)
  //
  // Most clients can ignore, this state is here
  // to give Protobuf clients (Python Client, Yamcs Studio)
  // the time to add a migration for supporting both WARNING
  // and WARNING_NEW (Protobuf serializes the number).
  //
  // Then in a later phase, we move from:
  // WARNING=1, WARNING_NEW=4
  //
  // To:
  // WARNING_OLD=1, WARNING=4
  //
  // (which is a transparent change to JSON clients)
  WARNING_NEW = "WARNING_NEW",
  DISTRESS = "DISTRESS",
  CRITICAL = "CRITICAL",
  SEVERE = "SEVERE",
}