/*
  Сервис реализует функционал опроса статусов сетевой доступности устройств
*/
syntax = "proto3";

import "google/api/annotations.proto";
import "google/api/field_behavior.proto";
import "google/protobuf/timestamp.proto";

package keyapis.telemetry_status.v1;

option java_package = "ru.keyapis.telemetry_status.v1";
option java_outer_classname = "KeyapisTelemetryStatusV1Proto";
option java_multiple_files = false;
option java_string_check_utf8 = true;
option go_package = "/keyapis_telemetry_status_v1";
option cc_enable_arenas = true;
option csharp_namespace = "Keyapis.TelemetryStatus.V1";
option objc_class_prefix = "KEYAPISTELEMETRYSTATUSV1";
option php_namespace = "Keyapis\\TelemetryStatus\\V1";
option ruby_package = "Keyapis::TelemetryStatus::V1";
option optimize_for = LITE_RUNTIME;

// Сервис опроса статусов сетевой доступности устройств.
// Авторизация:
//   - Authorization: Bearer token.
//   - X-Api-Key: apiKey
service DeviceStatusService {
  // Метод получения списка статусов доступности устройств.
  // Метод доступен для: Token: service, admin. Без учета разрешений.
  // Метод доступен для: ApiKey: Разрешения: telemetry_status:device_status:list
  rpc GetDeviceStatusList(GetDeviceStatusListRequest) returns (stream GetDeviceStatusListResponse) {
    option (google.api.http) = {
      get: "/telemetry_status/api/v1/device_status/list"
    };
  }
  // Метод получения количества статусов доступности устройств.
  // Метод доступен для: Token: service, admin. Без учета разрешений.
  // Метод доступен для: ApiKey: Разрешения: telemetry_status:device_status:list
  rpc GetDeviceStatusCount(GetDeviceStatusCountRequest) returns (GetDeviceStatusCountResponse) {
    option (google.api.http) = {
      get: "/telemetry_status/api/v1/device_status/count"
    };
  }
}

// Статус доступности устройства
message DeviceStatus {
  // Идентификатор устройства
  int32 device_id = 1 [(google.api.field_behavior) = REQUIRED];
  // IP-адрес устройства
  string ip = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
  // Момент проверки статуса
  google.protobuf.Timestamp checked_at = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
  // Справочник типов статусов
  enum StatusType {
    // Значение не указано.
    // Проверка доступности не выполнялась
    STATUS_TYPE_UNKNOWN = 0;
    // Не доступен
    OFFLINE = 1;
    // Доступен
    ONLINE = 2;
  }
  // Тип статуса
  StatusType status_type = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
}

// Фильтр для запроса статусов доступности устройств.
// При передаче массива в параметр фильтра элементы массива работают в выборке через ИЛИ.
// При передаче нескольких разных параметров фильтра они работают в выборке через И
message DeviceStatusFilter {
  // По списку приборов учета
  repeated int32 device_ids = 1;
  // По cтатусам доступности
  repeated DeviceStatus.StatusType status_types = 2;
}

// Пагинация статусов сетевой доступности
message DeviceStatusPaging {
  // Справочник типов значений сортировки
  enum OrderByType {
    // Значение не указано
    ORDER_BY_TYPE_UNKNOWN = 0;
    // По дате проверки
    CHECKED_AT = 1;
    // По идентификатору
    DEVICE_ID = 2;
  }
  // Тип значения сортировки.
  // По умолчанию: CHECKED_AT
  OrderByType order_by_type = 1;
  // Справочник типов направлений сортировки
  enum DirectionType {
    // Значение не указано
    DIRECTION_TYPE_UNKNOWN = 0;
    // От большего к меньшему
    DESC = 1;
    // От меньшего к большему
    ASC = 2;
  }
  // Тип направления сортировки.
  // По умолчанию: DESC
  DirectionType direction_type = 2;
  // Количество записей на страницу.
  // Минимальное значение: 1.
  // Максимальное значение: 100.
  // По умолчанию: 20.
  // Если значение 0 (не передано), то выставляем значение по умолчанию
  int32 limit = 3;
  // Сдвиг.
  // По умолчанию: 0
  int32 offset = 4;
}

// Запрос получения списка
message GetDeviceStatusListRequest {
  // Фильтр
  DeviceStatusFilter filter = 1;
  // Вариант разбиения на страницы
  oneof pagination {
    // Пагинация
    DeviceStatusPaging paging = 2;
  }
}
// Ответ на запрос получения списка статусов доступности устройств
message GetDeviceStatusListResponse {
  // Тип результата
  oneof type {
    // Статус доступности устройства
    DeviceStatus data = 1;
  }
}

// Запрос получения количества записей
message GetDeviceStatusCountRequest {
  // Фильтр
  DeviceStatusFilter filter = 1;
}
// Ответ на запрос получения количества записей
message GetDeviceStatusCountResponse {
  // Тип результата
  oneof type {
    // Всего записей
    int32 data = 1;
  }
}