/* Сервис реализует функционал управления измерениями */ syntax = "proto3"; import "google/api/annotations.proto"; import "google/api/field_behavior.proto"; import "google/protobuf/wrappers.proto"; import "google/protobuf/timestamp.proto"; package keyapis.telemetry_metric.v1; option java_package = "ru.keyapis.telemetry_metric.v1"; option java_outer_classname = "KeyapisTelemetryMetricV1Proto"; option java_multiple_files = false; option java_string_check_utf8 = true; option go_package = "/keyapis_telemetry_metric_v1"; option cc_enable_arenas = true; option csharp_namespace = "Keyapis.TelemetryMetric.V1"; option objc_class_prefix = "KEYAPISTELEMETRYMETRICYV1"; option php_namespace = "Keyapis\\TelemetryMetric\\V1"; option ruby_package = "Keyapis::TelemetryMetric::V1"; option optimize_for = LITE_RUNTIME; // Сервис измерений service MeasurementService { // Метод сохранения измерений. // Метод доступен для: service, application(telemetry:edit) rpc PostMeasurement(PostMeasurementRequest) returns (PostMeasurementResponse) { option (google.api.http) = { post: "/telemetry_metric/api/v1/measurement" }; } // Полудуплексный метод сохранения потока измерений. // Метод доступен для: service, application(telemetry:edit) rpc PostMeasurementHalfDuplex(stream PostMeasurementHalfDuplexRequest) returns (PostMeasurementHalfDuplexResponse) {} // Метод получения списка измерений. // Метод доступен для: service, application(telemetry:read или telemetry:edit) rpc GetMeasurementList(GetMeasurementListRequest) returns (stream GetMeasurementListResponse) { option (google.api.http) = { get: "/telemetry_metric/api/v1/measurement/list" }; } // Метод получения количества измерений. // Метод доступен для: service, application(telemetry:read или telemetry:edit) rpc GetMeasurementCount(GetMeasurementCountRequest) returns (GetMeasurementCountResponse) { option (google.api.http) = { get: "/telemetry_metric/api/v1/measurement/count" }; } // Метод получения списка преобразованных измерений. // Метод доступен для: service, application(telemetry:read или telemetry:edit) rpc GetMeasurementConvertedList(GetMeasurementConvertedListRequest) returns (stream GetMeasurementConvertedListResponse) { option (google.api.http) = { get: "/telemetry_metric/api/v1/measurement/converted/list" }; } // Метод получения количества преобразованных измерений. // Метод доступен для: service, application(telemetry:read или telemetry:edit) rpc GetMeasurementConvertedCount(GetMeasurementConvertedCountRequest) returns (GetMeasurementConvertedCountResponse) { option (google.api.http) = { get: "/telemetry_metric/api/v1/measurement/converted/count" }; } } // Запрос получения списка измерений message GetMeasurementListRequest { // Параметры фильтрации измерений MeasurementFilter filter = 1; // Вариант разбиения измерений на страницы oneof pagination { // Параметры пагинации по измерениям MeasurementPaging paging = 2; } } // Запрос получения списка преобразованных измерений message GetMeasurementConvertedListRequest { // Параметры фильтрации измерений MeasurementFilter filter = 1; // Вариант разбиения измерений на страницы oneof pagination { // Параметры пагинации по измерениям MeasurementPaging paging = 2; } } // Ответ на запрос получения списка измерений message GetMeasurementListResponse { // Тип результата oneof type { // Значение измерения Measurement data = 1; } } // Ответ на запрос получения списка преобразованных измерений message GetMeasurementConvertedListResponse { // Тип результата oneof type { // Значение измерения Measurement data = 1; } } // Фильтр измерений. // При передаче массива в параметр фильтра элементы массива работают в выборке через ИЛИ. // При передаче нескольких разных параметров фильтра они работают в выборке через И message MeasurementFilter { // По ФИАСам repeated string fias_ids = 1; // По идентификаторам repeated int32 device_ids = 2; // По идентификаторам индикаторов repeated int32 indicator_ids = 3; // От даты синхронизации включительно (>=) google.protobuf.Timestamp begin_synced_at = 4; // До даты синхронизации (<) google.protobuf.Timestamp end_synced_at = 5; // По моделям устройств repeated string device_models = 6; // По типам устройств repeated Measurement.DeviceType device_types = 7; // По типам измерений repeated Measurement.MetricType metric_types = 8; // Ограничение результатов только пограничными значениями для периода. // Если border_measurements_only=null возвращаем измерения по условиям фильтра, уникальные по (indicator_id, synced_at). // Если border_measurements_only=falsе возвращаем измерения по условиям фильтра, уникальные по (indicator_id, synced_at). // Если заданы border_measurements_only=true, begin_synced_at, end_synced_at возвращаем два измерения ближайшие к границам периода. // Если заданы border_measurements_only=true, и не задана end_synced_at возвращаем одно измерение ближайшее к begin_synced_at. // Если заданы border_measurements_only=true, и не задана begin_synced_at возвращаем одно измерение ближайшее к end_synced_at. // Если заданы border_measurements_only=true и не заданы begin_synced_at и end_synced_at возвращаем ошибку валидации параметров google.protobuf.BoolValue is_border_measurements_only = 9; } // Запрос получения количества измерений message GetMeasurementCountRequest { // Параметры фильтрации измерений MeasurementFilter filter = 1; } // Запрос получения количества преобразованных измерений message GetMeasurementConvertedCountRequest { // Параметры фильтрации измерений MeasurementFilter filter = 1; } // Ответ на запрос получения количества измерений message GetMeasurementCountResponse { // Тип результата oneof type { // Всего измерений int32 data = 1; } } // Ответ на запрос получения количества преобразованных измерений message GetMeasurementConvertedCountResponse { // Тип результата oneof type { // Всего измерений int32 data = 1; } } // Параметры пагинации измерений message MeasurementPaging { // Справочник типов значений сортировки enum OrderByType { // Значение не указано ORDER_BY_TYPE_UNKNOWN = 0; // По идентификатору индикатора INDICATOR_ID = 1; // По дате synced_at SYNCED_AT = 2; } // Тип значения сортировки. // По умолчанию: SYNCED_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 PostMeasurementRequest { // Измерение Measurement data = 1 [(google.api.field_behavior) = REQUIRED]; } // Ответ на запрос сохранения измерения message PostMeasurementResponse {} // Запрос сохранения потока измерения message PostMeasurementHalfDuplexRequest { // Измерение Measurement data = 1 [(google.api.field_behavior) = REQUIRED]; } // Ответ на запрос сохранения потока измерений message PostMeasurementHalfDuplexResponse {} // Измерение. // Очередь key.telemetry_consumer.measurement_stream_request.v1 message Measurement { // Идентификатор int32 indicator_id = 1 [(google.api.field_behavior) = REQUIRED]; // Значение float value = 2 [(google.api.field_behavior) = REQUIRED]; // Временная метка сбора счётчиком. // Если не передано берётся серверное время google.protobuf.Timestamp synced_at = 3; // ФИАС google.protobuf.StringValue fias_id = 4; // Идентификатор устройства google.protobuf.Int32Value device_id = 5; // Идентификатор родительского устройства google.protobuf.Int32Value device_parent_id = 6; // Модель устройства google.protobuf.StringValue device_model = 7; // Справочник типов устройств enum DeviceType { // Значение не указано DEVICE_TYPE_UNKNOWN = 0; // Коммуникационный модуль HUB = 1; // Счетчик импульсов - регистратор PULSE_COUNTER_RECORDER = 2; // Счетчик импульсов - регистратор LoRaWAN PULSE_COUNTER_RECORDER_LR = 3; // Прибор учета расхода коммунальных услуг METERING_DEVICE = 4; // Конвертер интерфейсов INTERFACE_CONVERTER = 5; // M-BUS концентратор M_BUS_HUB = 6; // Модуль связи LoRaWAN COMMUNICATION_MODULE_LR = 7; // Базовая станция LoRaWAN BASE_LR = 8; } // Тип устройства DeviceType device_type = 8; // Справочние типов энергоресурсов enum MetricType { // Значение не указано METRIC_TYPE_UNKNOWN = 0; // Горячая вода HOT_WATER = 1; // Холодная вода COLD_WATER = 2; // Теплоэнергия HEAT = 3; // Газ GAS = 4; // Электроэнергия ELECTRICITY = 5; } // Тип энергоресурса MetricType metric_type = 9; // Дата последнего изменения. // Заполняется и обновляется сервером. // Заполняется при создании и изменении. // Является версией объекта google.protobuf.Timestamp changed_at = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; // Сдвиг таймзоны относительно UTC для даты synced_at int32 utc_offset = 11; // Справочник типов единиц измерений enum UnitType { // Значение не указано UNIT_TYPE_UNKNOWN = 0; // Процент PERCENT = 1; // Градус по Цельсию C = 2; // Ватт WT = 3; // Гигакалория GKAL = 4; // Количество VALUE = 5; // Киловaтт-час KWH = 6; // Килограмм на квадратный сантиметр KG_CM2 = 7; // Килограмм-сила на квадратный сантиметр KGF_CM2 = 8; // Кубический метр M3 = 9; // Кубический метр в час M3_H = 10; // Мегапаскаль MPA = 11; // Миллисекунда MS = 12; // Флаг состояния BOOLEAN = 13; // Тонна T = 14; // Тонна в час T_H = 15; // Час H = 16; // Безразмерная величина NON_MEASURABLE = 17; // Импульс IMP = 18; // Джоуль J = 19; // Килоджоуль KJ = 20; // Гигаджоуль GJ = 21; // Ватт-час WTH = 22; // Киловатт KWT = 23; // Минута MIN = 24; // Секунда S = 25; } // Тип единицы измерения, в которой представлено, получаемое измерение UnitType unit_type = 12; }