# Протокол

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

- [keyapis/preset/v1/keyapis_preset_events_v1.proto](#keyapis_preset_v1_keyapis_preset_events_v1-proto)
    - [EventService](#keyapis-preset-v1-EventService)
  
    - [PostEventPresetInstallRequest](#keyapis-preset-v1-PostEventPresetInstallRequest)
    - [PostEventPresetInstallResponse](#keyapis-preset-v1-PostEventPresetInstallResponse)
    - [PresetConfigurationFailTask](#keyapis-preset-v1-PresetConfigurationFailTask)
    - [PresetConfigurationSuccessTask](#keyapis-preset-v1-PresetConfigurationSuccessTask)
    - [PresetConfigurationTask](#keyapis-preset-v1-PresetConfigurationTask)
    - [PresetInstallTask](#keyapis-preset-v1-PresetInstallTask)
  


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




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

## [keyapis/preset/v1/keyapis_preset_events_v1.proto](/protos/key/keyapis/preset/v1/keyapis_preset_events_v1.proto)
События пресетов


<a name="keyapis-preset-v1-EventService"></a>

### EventService
 Сервис событий пресетов

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-preset-v1-PostEventPresetInstall"></a> [PostEventPresetInstall](#keyapis-preset-v1-PostEventPresetInstall) | Метод установки пресета. Метод доступен для: admin, service | [keyapis.preset.v1.PostEventPresetInstallRequest](#keyapis-preset-v1-PostEventPresetInstallRequest) | [keyapis.preset.v1.PostEventPresetInstallResponse](#keyapis-preset-v1-PostEventPresetInstallResponse) |

 <!-- end services -->


<a name="keyapis-preset-v1-PostEventPresetInstallRequest"></a>


### [PostEventPresetInstallRequest](#keyapis-preset-v1-PostEventPresetInstallRequest)
 Запрос на установку пресета


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-PostEventPresetInstallRequest-id"></a> [id](#keyapis-preset-v1-PostEventPresetInstallRequest-id) | Идентификатор пресета |    [int32](#scalar-types) | REQUIRED|






<a name="keyapis-preset-v1-PostEventPresetInstallResponse"></a>


### [PostEventPresetInstallResponse](#keyapis-preset-v1-PostEventPresetInstallResponse)
 Ответ на запрос на установку пресета






<a name="keyapis-preset-v1-PresetConfigurationFailTask"></a>


### [PresetConfigurationFailTask](#keyapis-preset-v1-PresetConfigurationFailTask)
 Задача ошибки при конфигурации устройства.
Очередь key.preset.configuration_fail


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-PresetConfigurationFailTask-request_id"></a> [request_id](#keyapis-preset-v1-PresetConfigurationFailTask-request_id) | Идентификатор ответа |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-PresetConfigurationFailTask-device_id"></a> [device_id](#keyapis-preset-v1-PresetConfigurationFailTask-device_id) | Идентификатор устройства |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-PresetConfigurationFailTask-preset_id"></a> [preset_id](#keyapis-preset-v1-PresetConfigurationFailTask-preset_id) | Идентификатор пресета |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-PresetConfigurationFailTask-error_message"></a> [error_message](#keyapis-preset-v1-PresetConfigurationFailTask-error_message) | Текст ошибки |    [string](#scalar-types) | REQUIRED|






<a name="keyapis-preset-v1-PresetConfigurationSuccessTask"></a>


### [PresetConfigurationSuccessTask](#keyapis-preset-v1-PresetConfigurationSuccessTask)
 Задача успешной конфигурации устройства.
Очередь key.preset.configuration_success


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-PresetConfigurationSuccessTask-request_id"></a> [request_id](#keyapis-preset-v1-PresetConfigurationSuccessTask-request_id) | Идентификатор ответа |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-PresetConfigurationSuccessTask-device_id"></a> [device_id](#keyapis-preset-v1-PresetConfigurationSuccessTask-device_id) | Идентификатор устройства |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-PresetConfigurationSuccessTask-preset_id"></a> [preset_id](#keyapis-preset-v1-PresetConfigurationSuccessTask-preset_id) | Идентификатор пресета |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-PresetConfigurationSuccessTask-configured_at"></a> [configured_at](#keyapis-preset-v1-PresetConfigurationSuccessTask-configured_at) | Дата и время конфигурации |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | REQUIRED|






<a name="keyapis-preset-v1-PresetConfigurationTask"></a>


### [PresetConfigurationTask](#keyapis-preset-v1-PresetConfigurationTask)
 Задача на конфигурирование устройства.
Очередь key.preset.configuration


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-PresetConfigurationTask-request_id"></a> [request_id](#keyapis-preset-v1-PresetConfigurationTask-request_id) | Идентификатор запроса |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-PresetConfigurationTask-preset"></a> [preset](#keyapis-preset-v1-PresetConfigurationTask-preset) | Пресет |    [keyapis.preset.v1.Preset](#keyapis-preset-v1-Preset) | REQUIRED|
| <a id="keyapis-preset-v1-PresetConfigurationTask-device_id"></a> [device_id](#keyapis-preset-v1-PresetConfigurationTask-device_id) | Идентификатор устройства |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-PresetConfigurationTask-model"></a> [model](#keyapis-preset-v1-PresetConfigurationTask-model) | Модель |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-PresetConfigurationTask-host"></a> [host](#keyapis-preset-v1-PresetConfigurationTask-host) | Адрес устройства |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-PresetConfigurationTask-username"></a> [username](#keyapis-preset-v1-PresetConfigurationTask-username) | Имя пользователя устройства |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-PresetConfigurationTask-password"></a> [password](#keyapis-preset-v1-PresetConfigurationTask-password) | Пароль пользователья устройства |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-PresetConfigurationTask-ntp_timezone"></a> [ntp_timezone](#keyapis-preset-v1-PresetConfigurationTask-ntp_timezone) | Таймзона NTP |    [string](#scalar-types) | REQUIRED|






<a name="keyapis-preset-v1-PresetInstallTask"></a>


### [PresetInstallTask](#keyapis-preset-v1-PresetInstallTask)
 Задача на установку пресета.
Очередь key.preset.install


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-PresetInstallTask-request_id"></a> [request_id](#keyapis-preset-v1-PresetInstallTask-request_id) | Идентификатор запроса |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-PresetInstallTask-preset"></a> [preset](#keyapis-preset-v1-PresetInstallTask-preset) | Пресет |    [keyapis.preset.v1.Preset](#keyapis-preset-v1-Preset) | REQUIRED|





 <!-- end messages -->

 <!-- 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 |