Протокол¶
Оглавление¶
Схема классов¶
deviceapis/device/v1/deviceapis_device_ftp_v1.proto¶
Сервис управления настройками FTP
FtpService¶
Сервис управления настройками FTP
| Название метода | Описание | Тип запроса | Тип ответа |
|---|---|---|---|
| EditFtp | Метод редактирования настроек FTP | deviceapis.device.v1.EditFtpRequest | deviceapis.device.v1.EditFtpResponse |
| GetFtp | Метод получения настроек FTP | deviceapis.device.v1.GetFtpRequest | deviceapis.device.v1.GetFtpResponse |
| PostFtpBackup | Создать бэкап и положить на FTP папку | deviceapis.device.v1.PostFtpBackupRequest | deviceapis.device.v1.PostFtpBackupResponse |
| PostFtpBackupApply | Скачать бэкап из FTP папки и применить | deviceapis.device.v1.PostFtpBackupApplyRequest | deviceapis.device.v1.PostFtpBackupApplyResponse |
EditFtpRequest¶
Запрос редактирования настроек FTP
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Настройки FTP | deviceapis.device.v1.Ftp | REQUIRED |
| update_mask | Маска полей обновления | google.protobuf.FieldMask |
EditFtpResponse¶
Ответ на запрос редактирования настроек FTP
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Настройки FTP | optional deviceapis.device.v1.Ftp | |
| error | Ошибка | optional deviceapis.device.v1.EditFtpResponse.Error |
EditFtpResponse.Error¶
Ошибка запроса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional deviceapis.device.v1.ValidationError |
Ftp¶
Настройки FTP
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| reg_server_address | Адрес FTP сервера. Сетевой адрес и порт. Пример: 192.168.0.1:21, ftp.acme.io:21 | string | |
| login | Логин | string | |
| password | Пароль. Не возвращается с сервера. TODO: в генерации сваггера не показывать INPUT_ONLY поля в ответах | string | INPUT_ONLY |
GetFtpRequest¶
Запрос получения настроек FTP
GetFtpResponse¶
Ответ на запрос получения настроек FTP
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Настройки FTP | optional deviceapis.device.v1.Ftp |
PostFtpBackupApplyRequest¶
Запрос применения бекапа
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| ftp_path | Имя FTP папки | string | REQUIRED |
| file_name | Имя файла бекапа | string | REQUIRED |
| restore_options | Опции восстановления | string |
PostFtpBackupApplyResponse¶
Ответ на запрос применения бекапа
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| error | Ошибка | optional deviceapis.device.v1.PostFtpBackupApplyResponse.Error |
PostFtpBackupApplyResponse.Error¶
Ошибка запроса создания бекапа
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional deviceapis.device.v1.ValidationError |
PostFtpBackupRequest¶
Запрос создания бекапа
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| ftp_path | Имя FTP папки | string | REQUIRED |
| file_name | Имя файла бекапа | string | REQUIRED |
| backup_type | Тип бекапа | string | REQUIRED |
PostFtpBackupResponse¶
Ответ на запрос создания бекапа
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| error | Ошибка | optional deviceapis.device.v1.PostFtpBackupResponse.Error |
PostFtpBackupResponse.Error¶
Ошибка запроса создания бекапа
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional deviceapis.device.v1.ValidationError |
Скалярные типы значений¶
| .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 |