/* Сервис реализует функционал хранения пресетов устройств */ syntax = "proto3"; import "google/api/annotations.proto"; import "google/api/field_behavior.proto"; import "google/protobuf/descriptor.proto"; import "google/protobuf/timestamp.proto"; import "google/protobuf/wrappers.proto"; package keyapis.preset.v1; option java_package = "ru.keyapis.preset.v1"; option java_outer_classname = "KeyapisPresetV1Proto"; option java_multiple_files = false; option java_string_check_utf8 = true; option go_package = "/keyapis_preset_v1"; option cc_enable_arenas = true; option csharp_namespace = "Keyapis.Preset.V1"; option objc_class_prefix = "KEYAPISPRESETV1"; option php_namespace = "Keyapis\\Preset\\V1"; option ruby_package = "Keyapis::Preset::V1"; option optimize_for = LITE_RUNTIME; // Сервис пресетов service PresetService { // Метод сохранения пресетов. // Поддерживает создание и обновление. // При обновлении пресета посылается задача PresetInstallTask в очередь key.preset.install. // Данное сообщение должно отправляться только если изменению подверглось одно из следующих полей: // - Sip; // - Ntp; // - Syslog; // - Room; // - VideoConfig; // - Dtmf. // Метод доступен для: admin, service rpc PostPreset(PostPresetRequest) returns (PostPresetResponse) { option (google.api.http) = { post: "/preset/api/v1/preset", body: "*" }; } // Метод получения пресета по идентификатору. // Метод доступен для: admin, service, bti, ltp_first, owner, employee rpc GetPreset(GetPresetRequest) returns (GetPresetResponse) { option (google.api.http) = { get: "/preset/api/v1/preset/{id}" }; } // Метод получения дефолтного пресета. // Метод доступен для: admin, service, bti, ltp_first, owner, employee rpc GetPresetDefault(GetPresetDefaultRequest) returns (GetPresetDefaultResponse) { option (google.api.http) = { get: "/preset/api/v1/preset/default" }; } // Метод получения пресетов. // Метод доступен для: admin, service, bti, ltp_first, owner, employee rpc GetPresetList(GetPresetListRequest) returns (stream GetPresetListResponse) { option (google.api.http) = { get: "/preset/api/v1/preset/list" }; } // Метод получения количества пресетов. // Метод доступен для: admin, service, bti, ltp_first, owner, employee rpc GetPresetCount(GetPresetCountRequest) returns (GetPresetCountResponse) { option (google.api.http) = { get: "/preset/api/v1/preset/count" }; } // Метод удаления пресета. // Нельзя удалить пресет, если он используется на устройстве. // Нельзя удалить дефолтный пресет. // Метод доступен для: admin, service rpc DeletePreset(DeletePresetRequest) returns (DeletePresetResponse) { option (google.api.http) = { delete: "/preset/api/v1/preset/{id}" }; } } // Пресет. // Пресет с id=1 является дефолтным пресетом. // # Описание модели message Preset { // Идентификатор. // # Диапазон: 0..2147483647 int32 id = 1; // Наименование. // # Диапазон: 3..256 string title = 2 [(google.api.field_behavior) = REQUIRED]; // Идентификатор МРФ. // # Диапазон: 0..10 repeated int32 mrf_ids = 3 [(google.api.field_behavior) = REQUIRED]; // Идентификатор РФ. // # Диапазон: 0..100 repeated int32 rf_ids = 4 [(google.api.field_behavior) = REQUIRED]; // Описание. // # Диапазон: 3..1024 google.protobuf.StringValue description = 5 [(google.api.field_behavior) = OPTIONAL]; // Дата и время создания. // # Тип: DateTime google.protobuf.Timestamp created_at = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; // Дата последнего изменения. // Заполняется и обновляется сервером. // Заполняется при создании и изменении. // Является версией объекта. // # Тип: DateTime google.protobuf.Timestamp changed_at = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; // Справочник статусов. // # Тип: byte enum StatusType { // Значение не указано STATUS_TYPE_UNKNOWN = 0; // Активный ACTIVE = 1; // Архивный ARCHIVE = 2; } // Статус StatusType status_type = 8 [(google.api.field_behavior) = REQUIRED]; // Параметр SIP message Sip { // Хост. // # Диапазон: 5..256 string host = 1 [(google.api.field_behavior) = REQUIRED]; // Порт. // # Диапазон: 1..65536 int32 port = 2 [(google.api.field_behavior) = REQUIRED]; // Хост reg. // # Диапазон: 5..256 string reg_host = 3 [(google.api.field_behavior) = REQUIRED]; // Порт reg. // # Диапазон: 1..65536 int32 reg_port = 4 [(google.api.field_behavior) = REQUIRED]; // Хост proxy. // # Диапазон: 5..256 string proxy_host = 5 [(google.api.field_behavior) = REQUIRED]; // Порт proxy. // # Диапазон: 1..65536 int32 proxy_port = 6 [(google.api.field_behavior) = REQUIRED]; } // Параметр SIP Sip sip = 9 [(google.api.field_behavior) = REQUIRED]; // Параметр NTP message Ntp { // Хост. // # Диапазон: 5..256 string host = 1 [(google.api.field_behavior) = REQUIRED]; // Порт. // # Диапазон: 1..65536 int32 port = 2 [(google.api.field_behavior) = REQUIRED]; } // Параметр NTP Ntp ntp = 10 [(google.api.field_behavior) = REQUIRED]; // Параметр Syslog message Syslog { // Хост. // # Диапазон: 5..256 string host = 1 [(google.api.field_behavior) = REQUIRED]; // Порт. // # Диапазон: 1..65536 int32 port = 2 [(google.api.field_behavior) = REQUIRED]; // Тип протокола. // # Тип: byte enum ProtocolType { // Значение не указано PROTOCOL_TYPE_UNKNOWN = 0; // Протокол UDP UDP = 1; // Протокол TCP TCP = 2; } // Протокол ProtocolType protocol_type = 3 [(google.api.field_behavior) = REQUIRED]; } // Параметр Syslog Syslog syslog = 11 [(google.api.field_behavior) = REQUIRED]; // Помещение message Room { // Номер телефона. // # Диапазон: 5..14 string phone = 1 [(google.api.field_behavior) = REQUIRED]; // Номер помещения. // # Диапазон: 1..10000 int32 num = 2 [(google.api.field_behavior) = REQUIRED]; } // Помещения. // # Диапазон: 0..10000 repeated Room rooms = 12 [(google.api.field_behavior) = REQUIRED]; // Параметры конфигурации видео message VideoConfig { // Справочник качеств. // # Тип: byte enum QualityType { // Значение не указано QUALITY_TYPE_UNKNOWN = 0; // Высокое качество HIGH = 1; // Среднее качество MEDIUM = 2; } // Тип пресета QualityType quality_type = 1 [(google.api.field_behavior) = REQUIRED]; // Пользователь message RtspUser { // Имя пользователя. // # Диапазон: 3..256 string username = 1 [(google.api.field_behavior) = REQUIRED]; // Пароль. // # Диапазон: 3..256 string password = 2 [(google.api.field_behavior) = REQUIRED]; } // Пользователь RtspUser rtsp_user = 2 [(google.api.field_behavior) = REQUIRED]; } // Параметры конфигурации видео VideoConfig video_config = 13 [(google.api.field_behavior) = REQUIRED]; // Параметр DTMF message Dtmf { // Код. // # Диапазон: 1..1 string code = 1 [(google.api.field_behavior) = REQUIRED]; // Индекс реле. // # Диапазон: 0..64 int32 relay_index = 2; } // Параметр DTMF. // # Диапазон: 0..64 repeated Dtmf dtmf = 14 [(google.api.field_behavior) = REQUIRED]; // Распознование лиц message FaceRecognition { // Адрес string host = 1 [(google.api.field_behavior) = REQUIRED]; // Альтернативный адрес string alt_host = 2; // Путь запроса к серверу string endpoint = 3 [(google.api.field_behavior) = REQUIRED]; // Токен string auth_token = 4 [(google.api.field_behavior) = REQUIRED]; // Тип конфигурации enum ConfigurationType { // Значение не указано CONFIGURATION_TYPE_UNKNOWN = 0; // По умолчанию DEFAULT = 1; } // Тип конфигурации ConfigurationType configuration_type = 5 [(google.api.field_behavior) = REQUIRED]; // Идентификатор источника в identix string origin_id = 6 [(google.api.field_behavior) = REQUIRED]; // Идентификаторы групп профилей в identix repeated int32 group_ids = 7; } // Распознование лиц FaceRecognition face_recognition = 15; // Ошибка сохранения. // Эти проверки выполняются при работе с базой данных и сторонними сервисами message SavingError { // Конфликт версий. // Причины: // - В базе хранится другая версия строки, значения changed_at отличаются message Conflict {} // Недоступно для дефолтного пресета. // Причины: // - Смена статуса на Архивный message NotAllowedForDefault {} // Причина ошибки oneof reason { // Конфликт версий Conflict conflict = 1; // Запрещено для дефолтного пресета NotAllowedForDefault not_allowed_for_default = 2; } } } // Запрос на создание/изменение пресета message PostPresetRequest { // Пресет Preset data = 1 [(google.api.field_behavior) = REQUIRED]; } // Ответ на запрос на создание/изменение пресета message PostPresetResponse { // Ошибка запроса сохранения пресета message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; // Ошибка сохранения Preset.SavingError saving = 2; } } // Тип ответа oneof type { // Пресет Preset data = 1; // Ошибка Error error = 2; } } // Запрос на получение списка пресетов message GetPresetListRequest { // Фильтр PresetFilter filter = 1; // Вариант разбиения на страницы oneof pagination { // Стандартный постраничный вывод PresetPaging paging = 2; } } // Запрос получения пресета message GetPresetRequest { // Идентификатор int32 id = 1 [(google.api.field_behavior) = REQUIRED]; } // Ответ на запрос получения пресета message GetPresetResponse { // Тип результата oneof type { // Пресет Preset data = 1; } } // Запрос получения дефолтного пресета message GetPresetDefaultRequest {} // Ответ на запрос получения дефолтного пресета message GetPresetDefaultResponse { // Тип результата oneof type { // Пресет Preset data = 1; } } // Ответ на получение списка пресетов message GetPresetListResponse { // Ошибка запроса получения списка пресетов message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; } } // Тип результата oneof type { // Пресет Preset data = 1; // Ошибка Error error = 2; } } // Запрос получения количества пресетов message GetPresetCountRequest { // Фильтр PresetFilter filter = 1; } // Ответ на запрос получения количества пресетов message GetPresetCountResponse { // Ошибка запроса получения количества пресетов message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; } } // Тип результата oneof type { // Всего пресетов int32 data = 1; // Ошибка Error error = 2; } } // Запрос удаления пресета message DeletePresetRequest { // Идентификатор пресета int32 id = 1 [(google.api.field_behavior) = REQUIRED]; } // Ответ на запрос удаления пресета message DeletePresetResponse { // Ошибка при удалении message Error { // Недоступно для дефолтного пресета message NotAllowedForDefault {} // Причина ошибки oneof reason { // Запрещено для дефолтного пресета NotAllowedForDefault not_allowed_for_default = 1; } } // Тип ответа oneof type { // Ошибка при удалении Error error = 1; } } // Фильтр по пресетам message PresetFilter { // По идентификаторам МРФ repeated int32 mrf_ids = 1; // По идентификаторам РФ repeated int32 rf_ids = 2; // Поиск по тексту. // Если значение не передано то поиск по нему не производится. // # Диапазон: 3..64. // # Поиск производится по полям: // # - Наименование; // # - Описание google.protobuf.StringValue text = 3 [(google.api.field_behavior) = OPTIONAL]; // Поиск по наименованию. // Если значение не передано то поиск по нему не производится. // # Диапазон: 3..64. // # Поиск производится по полям: // # - Наименование google.protobuf.StringValue title = 4 [(google.api.field_behavior) = OPTIONAL]; // По статусам repeated Preset.StatusType status_types = 5 [(google.api.field_behavior) = OPTIONAL]; } // Постраничный вывод message PresetPaging { // Справочник типов значений сортировки. // # Тип: byte enum OrderByType { // Значение не указано ORDER_BY_TYPE_UNKNOWN = 0; // По идентификатору ID = 1; // По времени создания CREATED_AT = 2; // По времени изменения CHANGED_AT = 3; // По рангу для поиска по тексту. // Применяется когда передано поле для поиска по тексту. // В случае если текстовое поле не передано, применяется значение по умолчанию RANK = 4; } // Тип значения сортировки. // Если значение не передано, то будет взято значение по умолчанию. // # По умолчанию: CHANGED_AT OrderByType order_by_type = 1; // Справочник типов направлений сортировки. // # Тип: byte enum DirectionType { // Значение не указано DIRECTION_TYPE_UNKNOWN = 0; // От большего к меньшему DESC = 1; // От меньшего к большему ASC = 2; } // Тип направления сортировки. // # По умолчанию: DESC DirectionType direction_type = 2; // Количество записей на страницу. // Если значение 0 (не передано), то будет взято значение по умолчанию. // # Диапазон: 0..100. // # По умолчанию: 20 int32 limit = 3; // Сдвиг. // # Диапазон: 0..2147483647 int32 offset = 4; } // Ошибки валидации. // Эти проверки выполняются до обращения в базу данных message ValidationError { // Путь к полю в формате наименования прото string path = 1 [(google.api.field_behavior) = REQUIRED]; // Валидационное сообщение string message = 2 [(google.api.field_behavior) = REQUIRED]; }