# Протокол

## Оглавление

- [keyapis/telemetry_control/v1/keyapis_telemetry_control_events_v1.proto](#keyapis_telemetry_control_v1_keyapis_telemetry_control_events_v1-proto)
    - [CollectorParams](#keyapis-telemetry_control-v1-CollectorParams)
    - [EICAllFiasStartTask](#keyapis-telemetry_control-v1-EICAllFiasStartTask)
  
    - [CollectorParams.ArchiveType](#keyapis-telemetry_control-v1-CollectorParams-ArchiveType)
    - [CollectorParams.SignType](#keyapis-telemetry_control-v1-CollectorParams-SignType)
  


## [Схема классов](/svg/protos/key/keyapis/telemetry_control/v1/keyapis_telemetry_control_events_v1.proto.svg)
<a href="/svg/protos/key/keyapis/telemetry_control/v1/keyapis_telemetry_control_events_v1.proto.svg"><img src="/svg/protos/key/keyapis/telemetry_control/v1/keyapis_telemetry_control_events_v1.proto.svg" alt="/svg/protos/key/keyapis/telemetry_control/v1/keyapis_telemetry_control_events_v1.proto.svg" style="height:100%;"></a>




<a name="keyapis_telemetry_control_v1_keyapis_telemetry_control_events_v1-proto"></a>

## [keyapis/telemetry_control/v1/keyapis_telemetry_control_events_v1.proto](/protos/key/keyapis/telemetry_control/v1/keyapis_telemetry_control_events_v1.proto)
Сервис реализует поток изменений ресурсов домена Телеметрии

 <!-- end services -->


<a name="keyapis-telemetry_control-v1-CollectorParams"></a>


### [CollectorParams](#keyapis-telemetry_control-v1-CollectorParams)
 Параметры сбора показаний


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-telemetry_control-v1-CollectorParams-date"></a> [date](#keyapis-telemetry_control-v1-CollectorParams-date) | Дата в формате YYYYMMDD. При пустой дате запускается на текущую дату |    [string](#scalar-types) | <nil>|
| <a id="keyapis-telemetry_control-v1-CollectorParams-archive_type"></a> [archive_type](#keyapis-telemetry_control-v1-CollectorParams-archive_type) | Тип архивности. При отсутствии переданного значения, будут запрошены показания по всем возможным типам архивности |    [keyapis.telemetry_control.v1.CollectorParams.ArchiveType](#keyapis-telemetry_control-v1-CollectorParams-ArchiveType) | <nil>|
| <a id="keyapis-telemetry_control-v1-CollectorParams-sign_type"></a> [sign_type](#keyapis-telemetry_control-v1-CollectorParams-sign_type) | Tип измерений. При отсутствии переданного значения, будут запрошены показания по всем возможным типам измерений |    [keyapis.telemetry_control.v1.CollectorParams.SignType](#keyapis-telemetry_control-v1-CollectorParams-SignType) | <nil>|






<a name="keyapis-telemetry_control-v1-EICAllFiasStartTask"></a>


### [EICAllFiasStartTask](#keyapis-telemetry_control-v1-EICAllFiasStartTask)
 Сигнал на старт сбора показаний Enviro по всем домам, на указанную дату.
Очередь key.telemetry_control.eic_all_fias_start_task


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-telemetry_control-v1-EICAllFiasStartTask-collector_params"></a> [collector_params](#keyapis-telemetry_control-v1-EICAllFiasStartTask-collector_params) | Параметры сбора показаний |    [keyapis.telemetry_control.v1.CollectorParams](#keyapis-telemetry_control-v1-CollectorParams) | REQUIRED|





 <!-- end messages -->



<a name="keyapis-telemetry_control-v1-CollectorParams-ArchiveType"></a>

### [CollectorParams.ArchiveType](#keyapis-telemetry_control-v1-CollectorParams-ArchiveType)
 Справочник типа архивности показаний.
Используется для указания за какой период произошло измерение

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-telemetry_control-v1-CollectorParams-ArchiveType-ARCHIVE_TYPE_UNKNOWN"></a> [ARCHIVE_TYPE_UNKNOWN](#keyapis-telemetry_control-v1-CollectorParams-ArchiveType-ARCHIVE_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-telemetry_control-v1-CollectorParams-ArchiveType-CURRENT"></a> [CURRENT](#keyapis-telemetry_control-v1-CollectorParams-ArchiveType-CURRENT) | Текущие показания |
| 2 | <a id="keyapis-telemetry_control-v1-CollectorParams-ArchiveType-HALFHOUR"></a> [HALFHOUR](#keyapis-telemetry_control-v1-CollectorParams-ArchiveType-HALFHOUR) | За 30 мин |
| 3 | <a id="keyapis-telemetry_control-v1-CollectorParams-ArchiveType-HOUR"></a> [HOUR](#keyapis-telemetry_control-v1-CollectorParams-ArchiveType-HOUR) | За час |
| 4 | <a id="keyapis-telemetry_control-v1-CollectorParams-ArchiveType-DAY"></a> [DAY](#keyapis-telemetry_control-v1-CollectorParams-ArchiveType-DAY) | За сутки |
| 5 | <a id="keyapis-telemetry_control-v1-CollectorParams-ArchiveType-MONTH"></a> [MONTH](#keyapis-telemetry_control-v1-CollectorParams-ArchiveType-MONTH) | За месяц |
| 6 | <a id="keyapis-telemetry_control-v1-CollectorParams-ArchiveType-YEAR"></a> [YEAR](#keyapis-telemetry_control-v1-CollectorParams-ArchiveType-YEAR) | За год |




<a name="keyapis-telemetry_control-v1-CollectorParams-SignType"></a>

### [CollectorParams.SignType](#keyapis-telemetry_control-v1-CollectorParams-SignType)
 Справочник типов измерений

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-telemetry_control-v1-CollectorParams-SignType-SIGN_TYPE_UNKNOWN"></a> [SIGN_TYPE_UNKNOWN](#keyapis-telemetry_control-v1-CollectorParams-SignType-SIGN_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-telemetry_control-v1-CollectorParams-SignType-ABSOLUTE_DS"></a> [ABSOLUTE_DS](#keyapis-telemetry_control-v1-CollectorParams-SignType-ABSOLUTE_DS) | Абсолютный показатель |
| 2 | <a id="keyapis-telemetry_control-v1-CollectorParams-SignType-ABSOLUTE_RC"></a> [ABSOLUTE_RC](#keyapis-telemetry_control-v1-CollectorParams-SignType-ABSOLUTE_RC) | Абсолютный расход ресурса |
| 3 | <a id="keyapis-telemetry_control-v1-CollectorParams-SignType-INTERVAL_DS"></a> [INTERVAL_DS](#keyapis-telemetry_control-v1-CollectorParams-SignType-INTERVAL_DS) | Интервальный показатель состояния |
| 4 | <a id="keyapis-telemetry_control-v1-CollectorParams-SignType-INTERVAL_RC"></a> [INTERVAL_RC](#keyapis-telemetry_control-v1-CollectorParams-SignType-INTERVAL_RC) | Интервальный расход ресурса |
| 5 | <a id="keyapis-telemetry_control-v1-CollectorParams-SignType-CURRENT_DS"></a> [CURRENT_DS](#keyapis-telemetry_control-v1-CollectorParams-SignType-CURRENT_DS) | Текущее состояние |
| 6 | <a id="keyapis-telemetry_control-v1-CollectorParams-SignType-CURRENT_RS"></a> [CURRENT_RS](#keyapis-telemetry_control-v1-CollectorParams-SignType-CURRENT_RS) | Текущее состояние ресурса |
| 7 | <a id="keyapis-telemetry_control-v1-CollectorParams-SignType-VOLUME"></a> [VOLUME](#keyapis-telemetry_control-v1-CollectorParams-SignType-VOLUME) | Объём |
| 8 | <a id="keyapis-telemetry_control-v1-CollectorParams-SignType-PARAMETER"></a> [PARAMETER](#keyapis-telemetry_control-v1-CollectorParams-SignType-PARAMETER) | Параметр конфигурации |
| 9 | <a id="keyapis-telemetry_control-v1-CollectorParams-SignType-FLAG"></a> [FLAG](#keyapis-telemetry_control-v1-CollectorParams-SignType-FLAG) | Флаг состояния |


 <!-- end enums -->

 <!-- end HasExtensions -->



## Скалярные типы значений
<a id="scalar-types"></a>

| .proto Type | Примечание | Python | Go | Ruby | C# | C++ | Java | PHP |
| ----------- | ---------- | ------ | -- | ---- | -- | --- | ---- | --- |
| [double](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | float | float64 | Float | double | double | double | float |
| [float](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | float | float32 | Float | float | float | float | float |
| [int32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [int64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [uint32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. | int/long | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| [uint64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. | int/long | uint64 | Bignum or Fixnum (as required) | ulong | uint64 | long | integer/string |
| [sint32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [sint64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [fixed32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | int | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| [fixed64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | int/long | uint64 | Bignum | ulong | uint64 | long | integer/string |
| [sfixed32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always four bytes. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [sfixed64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always eight bytes. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [bool](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | boolean | bool | TrueClass/FalseClass | bool | bool | boolean | boolean |
| [string](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | A string must always contain UTF-8 encoded or 7-bit ASCII text. | str/unicode | string | String (UTF-8) | string | string | String | string |
| [bytes](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | May contain any arbitrary sequence of bytes. | str | []byte | String (ASCII-8BIT) | ByteString | string | ByteString | string |