Протокол¶
Оглавление¶
-
deviceapis/device/v1/deviceapis_device_encryption_profile_v1.proto
- DeleteEncryptionProfileListResponse
- DeleteEncryptionProfileListResponse.Error
- DeleteEncryptionProfileRequest
- DeleteEncryptionProfileResponse
- DeleteEncryptionProfileResponse.Error
- EncryptionProfile
- EncryptionProfile.DeletingError
- EncryptionProfile.DeletingError.EncryptionProfileInUse
- EncryptionProfile.SavingError
- EncryptionProfile.SavingError.DuplicateName
- EncryptionProfile.SavingError.TooMuchEncryptionProfiles
- EncryptionProfileFilter
- GetEncryptionProfileListRequest
- GetEncryptionProfileListResponse
- GetEncryptionProfileRequest
- GetEncryptionProfileResponse
- SaveEncryptionProfileRequest
- SaveEncryptionProfileResponse
Схема классов¶
deviceapis/device/v1/deviceapis_device_encryption_profile_v1.proto¶
Сервис профилей шифрования устройства
EncryptionProfileService¶
Сервис профилей шифрования устройства
| Название метода | Описание | Тип запроса | Тип ответа |
|---|---|---|---|
| DeleteEncryptionProfile | Метод удаления единичной сущности EncryptionProfile по ключу | deviceapis.device.v1.DeleteEncryptionProfileRequest | deviceapis.device.v1.DeleteEncryptionProfileResponse |
| DeleteEncryptionProfileList | Метод удаления списка сущностей EncryptionProfile по фильтру | deviceapis.device.v1.DeleteEncryptionProfileListRequest | deviceapis.device.v1.DeleteEncryptionProfileListResponse |
| GetEncryptionProfile | Метод получения единичной сущности EncryptionProfile по ключу | deviceapis.device.v1.GetEncryptionProfileRequest | deviceapis.device.v1.GetEncryptionProfileResponse |
| GetEncryptionProfileList | Метод получения списка сущностей EncryptionProfile по фильтру | deviceapis.device.v1.GetEncryptionProfileListRequest | deviceapis.device.v1.GetEncryptionProfileListResponse |
| SaveEncryptionProfile | Метод создания сущности EncryptionProfile | deviceapis.device.v1.SaveEncryptionProfileRequest | deviceapis.device.v1.SaveEncryptionProfileResponse |
DeleteEncryptionProfileListRequest¶
Запрос удаления списка сущностей EncryptionProfile по фильтру
DeleteEncryptionProfileListResponse¶
Ответ на запрос удаления списка сущностей EncryptionProfile по фильтру
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Всего количество удаленных | optional int32 | |
| error | Ошибка | optional deviceapis.device.v1.DeleteEncryptionProfileListResponse.Error |
DeleteEncryptionProfileListResponse.Error¶
Ошибка запроса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional deviceapis.device.v1.ValidationError | |
| deleting | Ошибка удаления | optional deviceapis.device.v1.EncryptionProfile.DeletingError |
DeleteEncryptionProfileRequest¶
Запрос удаления единичной сущности EncryptionProfile по ключу
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор. Тип: Guid | string | REQUIRED |
DeleteEncryptionProfileResponse¶
Ответ на запрос удаления единичной сущности EncryptionProfile по ключу
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Всего количество удаленных | optional int32 | |
| error | Ошибка | optional deviceapis.device.v1.DeleteEncryptionProfileResponse.Error |
DeleteEncryptionProfileResponse.Error¶
Ошибка запроса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional deviceapis.device.v1.ValidationError | |
| deleting | Ошибка удаления | optional deviceapis.device.v1.EncryptionProfile.DeletingError |
EncryptionProfile¶
Профиль шифрования
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор. Тип: Guid | string | |
| title | Наименование | string | REQUIRED |
| type | Тип | deviceapis.device.v1.EncryptionProfile.Type | REQUIRED |
| sector_number | Номер сектора | int32 | REQUIRED |
| block_number | Номер блока | int32 | REQUIRED |
| start_index | Первый байт в блоке | int32 | REQUIRED |
| end_index | Последний байт в блоке | int32 | REQUIRED |
| password | Пароль. Не возвращается с сервера. TODO: в генерации сваггера не показывать INPUT_ONLY поля в ответах | string | INPUT_ONLY |
EncryptionProfile.DeletingError¶
Ошибка удаления
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор профиля шифрования, к которому относится ошибка. Тип: Guid | string | REQUIRED |
| encryption_profile_in_use | Профиль используется на устройстве | optional deviceapis.device.v1.EncryptionProfile.DeletingError.EncryptionProfileInUse |
EncryptionProfile.DeletingError.EncryptionProfileInUse¶
Профиль шифрования используется на устройстве
EncryptionProfile.SavingError¶
Ошибка сохранения. Эти проверки выполняются при работе с базой данных и сторонними сервисами
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| duplicate_name | Профиль с таким наименованием уже существует | optional deviceapis.device.v1.EncryptionProfile.SavingError.DuplicateName | |
| too_much_encryption_profiles | Превышено допустимое количество профилей шифрования | optional deviceapis.device.v1.EncryptionProfile.SavingError.TooMuchEncryptionProfiles |
EncryptionProfile.SavingError.DuplicateName¶
Профиль с таким наименованием уже существует
EncryptionProfile.SavingError.TooMuchEncryptionProfiles¶
Превышено допустимое количество профилей шифрования
EncryptionProfileFilter¶
Фильтр по профилям шифрования
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| text | Поиск по тексту. Если значение не передано то поиск по нему не производится. Поиск производится по полям: # - Наименование | google.protobuf.StringValue |
GetEncryptionProfileListRequest¶
Запрос получения списка сущностей EncryptionProfile по фильтру
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр по профилям шифрования | deviceapis.device.v1.EncryptionProfileFilter |
GetEncryptionProfileListResponse¶
Ответ на запрос получения списка сущностей EncryptionProfile по фильтру
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Список EncryptionProfile | repeated deviceapis.device.v1.EncryptionProfile |
GetEncryptionProfileRequest¶
Запрос получения единичной сущности EncryptionProfile по ключу
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор. Тип: Guid | string | REQUIRED |
GetEncryptionProfileResponse¶
Ответ на запрос получения единичной сущности EncryptionProfile по ключу
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Профиль шифрования | optional deviceapis.device.v1.EncryptionProfile |
SaveEncryptionProfileRequest¶
Запрос на создание сущности EncryptionProfile
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Профиль шифрования | deviceapis.device.v1.EncryptionProfile | REQUIRED |
SaveEncryptionProfileResponse¶
Ответ на запрос на создание сущности EncryptionProfile
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Профиль шифрования | optional deviceapis.device.v1.EncryptionProfile | |
| error | Ошибка | optional deviceapis.device.v1.SaveEncryptionProfileResponse.Error |
SaveEncryptionProfileResponse.Error¶
Ошибка запроса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional deviceapis.device.v1.ValidationError | |
| saving | Ошибка сохранения | optional deviceapis.device.v1.EncryptionProfile.SavingError |
EncryptionProfile.Type¶
Тип
| Номер | Тип | Название |
|---|---|---|
| 0 | TYPE_UNKNOWN | Значение не указано |
| 1 | SL3 | Тип SL3 |
| 2 | SL1 | Тип SL1 |
Скалярные типы значений¶
| .proto Type | Примечание | Python | Go | Ruby | C# | C++ | Java | PHP |
|---|---|---|---|---|---|---|---|---|
| double | float | float64 | Float | double | double | double | float | |
| float | float | float32 | Float | float | float | float | float | |
| int32 | 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 | 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 | Uses variable-length encoding. | int/long | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| uint64 | Uses variable-length encoding. | int/long | uint64 | Bignum or Fixnum (as required) | ulong | uint64 | long | integer/string |
| sint32 | 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 | 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 | 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 | 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 | Always four bytes. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| sfixed64 | Always eight bytes. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| bool | boolean | bool | TrueClass/FalseClass | bool | bool | boolean | boolean | |
| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | str/unicode | string | String (UTF-8) | string | string | String | string |
| bytes | May contain any arbitrary sequence of bytes. | str | []byte | String (ASCII-8BIT) | ByteString | string | ByteString | string |