Протокол¶
Оглавление¶
-
keyapis/access_control/v1/keyapis_access_control_flatgramm_v1.proto
- DcCompanyFlatgrammFilter
- DcCompanyFlatgrammPaging
- Flatgramm
- FlatgrammCompanyRelation
- FlatgrammCompanyRelationFilter
- FlatgrammCompanyRelationPaging
- FlatgrammFilter
- FlatgrammPaging
- GetFlatgrammCompanyRelationCountRequest
- GetFlatgrammCompanyRelationCountResponse
- GetFlatgrammCompanyRelationCountResponse.Error
- GetFlatgrammCompanyRelationListRequest
- GetFlatgrammCompanyRelationListResponse
- GetFlatgrammCompanyRelationListResponse.Error
- GetFlatgrammCountRequest
- GetFlatgrammCountResponse
- GetFlatgrammDcCompanyCountRequest
- GetFlatgrammDcCompanyCountResponse
- GetFlatgrammDcCompanyCountResponse.Error
- GetFlatgrammDcCompanyListRequest
- GetFlatgrammDcCompanyListResponse
- GetFlatgrammDcCompanyListResponse.Error
- GetFlatgrammListRequest
- GetFlatgrammListResponse
- GetFlatgrammListResponse.Error
- GetFlatgrammRequest
- GetFlatgrammResponse
- GetFlatgrammResponse.Error
- PutFlatgrammCompanyRelationAttachRequest
- PutFlatgrammCompanyRelationAttachResponse
- PutFlatgrammCompanyRelationAttachResponse.Error
- PutFlatgrammCompanyRelationDetachRequest
- PutFlatgrammCompanyRelationDetachResponse
- PutFlatgrammCompanyRelationDetachResponse.Error
- PutFlatgrammDcCompanyAttachRequest
- PutFlatgrammDcCompanyAttachResponse
- PutFlatgrammDcCompanyAttachResponse.Error
- PutFlatgrammDcCompanyDetachRequest
- PutFlatgrammDcCompanyDetachResponse
- DcCompanyFlatgrammPaging.OrderByType
- FlatgrammCompanyRelation.Type
- FlatgrammCompanyRelationPaging.DirectionType
- FlatgrammCompanyRelationPaging.OrderByType
- FlatgrammPaging.DirectionType
- FlatgrammPaging.OrderByType
Схема классов¶
keyapis/access_control/v1/keyapis_access_control_flatgramm_v1.proto¶
Сервис реализует функционал управления квартирограммами. В настоящий момент Квартирограмма является корневым агрегатом для домов, принадлежит управляющей компании. На транспортном уровне определяет связи между устройствами и квартирами
FlatgrammService¶
Сервис управления квартирограммами
| Название метода | Описание | Тип запроса | Тип ответа |
|---|---|---|---|
| GetFlatgramm | Метод получения облегченной квартирограммы. Для пользователей типов owner, employee возвращаются только квартирограммы привязанные к компании пользователя. Для пользователей типов owner, employee: в результат попадают только квартирограммы, привязанные к компании пользователя по любому из типов связи FlatgrammCompanyRelation.Type. Метод доступен для: admin, manager, service, bti, ltp_first, owner, employee | keyapis.access_control.v1.GetFlatgrammRequest | keyapis.access_control.v1.GetFlatgrammResponse |
| GetFlatgrammList | Метод получения списка облегченных квартирограмм. Для пользователей типов owner, employee: в результат фильтрации попадают только квартирограммы компании пользователя. Для пользователей типов owner, employee: если filter.company_ids непустое и не совпадает с COMPANY_ID пользователя, метод вернет PERMISSION_DENIED = 7 (403 Forbidden). Для пользователей типов owner, employee: если filter.company_ids пустое, то фильтрация по COMPANY_ID пользователя. Метод доступен для: admin, manager, service, bti, ltp_first, owner, employee | keyapis.access_control.v1.GetFlatgrammListRequest | keyapis.access_control.v1.GetFlatgrammListResponse stream |
| GetFlatgrammCount | Метод получения количества квартирограмм. Для пользователей типов owner, employee: в результат фильтрации попадают только квартирограммы компании пользователя. Для пользователей типов owner, employee: если filter.company_ids непустое и не совпадает с COMPANY_ID пользователя, метод вернет PERMISSION_DENIED = 7 (403 Forbidden). Для пользователей типов owner, employee: если filter.company_ids пустое, то фильтрация по COMPANY_ID пользователя. Метод доступен для: admin, manager, service, bti, ltp_first, owner, employee | keyapis.access_control.v1.GetFlatgrammCountRequest | keyapis.access_control.v1.GetFlatgrammCountResponse |
| GetFlatgrammDcCompanyList | Deprecated. Метод получения списка связей квартирограмм и домофонной компании. Метод доступен для: admin, service, seller | keyapis.access_control.v1.GetFlatgrammDcCompanyListRequest | keyapis.access_control.v1.GetFlatgrammDcCompanyListResponse stream |
| GetFlatgrammCompanyRelationList | Метод получения списка связей квартирограмм и компаний. Метод доступен для: admin, service, seller | keyapis.access_control.v1.GetFlatgrammCompanyRelationListRequest | keyapis.access_control.v1.GetFlatgrammCompanyRelationListResponse stream |
| GetFlatgrammDcCompanyCount | Deprecated. Метод получения количества связей квартирограмм и домофонной компании. Метод доступен для: admin, service, seller | keyapis.access_control.v1.GetFlatgrammDcCompanyCountRequest | keyapis.access_control.v1.GetFlatgrammDcCompanyCountResponse |
| GetFlatgrammCompanyRelationCount | Метод получения количества связей квартирограмм и компаний. Метод доступен для: admin, service, seller | keyapis.access_control.v1.GetFlatgrammCompanyRelationCountRequest | keyapis.access_control.v1.GetFlatgrammCompanyRelationCountResponse |
| PutFlatgrammDcCompanyAttach | Deprecated. Метод сохранения связей квартирограмм и домофонной компании. Поддерживает только создание. Метод доступен для: admin, service, seller | keyapis.access_control.v1.PutFlatgrammDcCompanyAttachRequest | keyapis.access_control.v1.PutFlatgrammDcCompanyAttachResponse |
| PutFlatgrammCompanyRelationAttach | Метод сохранения связей квартирограммы и компании. Поддерживает только создание. Метод доступен для: admin, service, seller | keyapis.access_control.v1.PutFlatgrammCompanyRelationAttachRequest | keyapis.access_control.v1.PutFlatgrammCompanyRelationAttachResponse |
| PutFlatgrammDcCompanyDetach | Deprecated. Метод удаления связей квартирограмм и домофонной компании. Метод доступен для: admin, service, seller | keyapis.access_control.v1.PutFlatgrammDcCompanyDetachRequest | keyapis.access_control.v1.PutFlatgrammDcCompanyDetachResponse |
| PutFlatgrammCompanyRelationDetach | Метод удаления связей квартирограммы и компании. Метод доступен для: admin, service, seller | keyapis.access_control.v1.PutFlatgrammCompanyRelationDetachRequest | keyapis.access_control.v1.PutFlatgrammCompanyRelationDetachResponse |
DcCompanyFlatgramm¶
Deprecated. Связка квартирограммы и домофонной компании. Задает область ресурсов (resource scope), доступную пользователю. Используется для контроля доступа к квартирограмме
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| company_id | Идентификатор домофонной компании. # Диапазон: 0..2147483647 | int32 | REQUIRED |
| flatgramm_id | Идентификатор квартирограммы. # Диапазон: 0..2147483647 | int32 | REQUIRED |
DcCompanyFlatgrammFilter¶
Deprecated. Фильтр для запроса связей квартирограммы и домофонной компании. При передаче массива в параметр фильтра элементы массива работают в выборке через ИЛИ. При передаче нескольких разных параметров фильтра они работают в выборке через И
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| company_ids | По Идентификатору домофонной компании | repeated int32 | |
| flatgramm_ids | По Идентификатору квартирограммы | repeated int32 |
DcCompanyFlatgrammPaging¶
Deprecated. Пагинация квартирограмм и домофонной компании
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| order_by_type | Тип значения сортировки. По умолчанию: COMPANY_ID | keyapis.access_control.v1.DcCompanyFlatgrammPaging.OrderByType | |
| direction_type | Тип направления сортировки. По умолчанию: DESC | keyapis.access_control.v1.DcCompanyFlatgrammPaging.DirectionType | |
| limit | Количество записей на страницу. Минимальное значение: 1. Максимальное значение: 100. По умолчанию: 20. Если значение 0 (не передано), то выставляем значение по умолчанию | int32 | |
| offset | Сдвиг. По умолчанию: 0 | int32 |
Flatgramm¶
Облегченная квартирограмма
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор | int32 | |
| title | Наименование | string | REQUIRED |
| company_id | Идентификатор компании - владельца | int32 | |
| created_at | Дата и время создания. # Тип: DateTime | google.protobuf.Timestamp | OUTPUT_ONLY |
| changed_at | Дата последнего изменения. Заполняется и обновляется сервером. Заполняется при создании и изменении. Является версией объекта. # Тип: DateTime | google.protobuf.Timestamp | OUTPUT_ONLY |
FlatgrammCompanyRelation¶
Связка квартирограммы и компании. Задает область ресурсов (resource scope), доступную пользователю. Используется для контроля доступа к квартирограмме
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| company_id | Идентификатор компании. # Диапазон: 1..2147483647 | int32 | REQUIRED |
| flatgramm_id | Идентификатор квартирограммы. # Диапазон: 1..2147483647 | int32 | REQUIRED |
| type | Тип связи компании и квартирограммы | keyapis.access_control.v1.FlatgrammCompanyRelation.Type | REQUIRED |
FlatgrammCompanyRelationFilter¶
Фильтр для запроса связей квартирограммы и компании. При передаче массива в параметр фильтра элементы массива работают в выборке через ИЛИ. При передаче нескольких разных параметров фильтра они работают в выборке через И
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| flatgramm_ids | По Идентификатору квартирограммы | repeated int32 | |
| company_ids | По Идентификатору компании | repeated int32 | |
| flatgramm_company_relation_types | Тип назначения компании для квартирограммы | repeated keyapis.access_control.v1.FlatgrammCompanyRelation.Type |
FlatgrammCompanyRelationPaging¶
Пагинация квартирограмм и компаний
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| order_by_type | Тип значения сортировки. По умолчанию: COMPANY_ID | keyapis.access_control.v1.FlatgrammCompanyRelationPaging.OrderByType | |
| direction_type | Тип направления сортировки. По умолчанию: DESC | keyapis.access_control.v1.FlatgrammCompanyRelationPaging.DirectionType | |
| limit | Количество записей на страницу. Минимальное значение: 1. Максимальное значение: 100. По умолчанию: 20. Если значение 0 (не передано), то выставляем значение по умолчанию | int32 | |
| offset | Сдвиг. По умолчанию: 0 | int32 |
FlatgrammFilter¶
Фильтр квартирограмм
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| company_ids | По идентификаторам компаний. Фильтрация среди компаний, тип связи компании и КВГ определяется по полю company_relation_types. Если company_relation_types не передан, то учитываются все значения типа FlatgrammCompanyRelation.Type | repeated int32 | |
| text | Поиск по тексту. Если значение не передано то поиск по нему не производится. # Диапазон: 3..64. # Поиск производится по полям: # - Наименование | string | |
| dc_company_ids | Deprecated. По идентификаторам компаний. Фильтрация среди компаний, привязанных как домофонные компании | repeated int32 | |
| flatgramm_company_relation_types | По типу связи квартирограмм и компаний | repeated keyapis.access_control.v1.FlatgrammCompanyRelation.Type |
FlatgrammPaging¶
Постраничный вывод
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| order_by_type | Тип значения сортировки. Если значение не передано, то будет взято значение по умолчанию. # По умолчанию: CHANGED_AT | keyapis.access_control.v1.FlatgrammPaging.OrderByType | |
| direction_type | Тип направления сортировки. # По умолчанию: DESC | keyapis.access_control.v1.FlatgrammPaging.DirectionType | |
| limit | Количество записей на страницу. Если значение 0 (не передано), то будет взято значение по умолчанию. # Диапазон: 0..100. # По умолчанию: 20 | int32 | |
| offset | Сдвиг. # Диапазон: 0..2147483647 | int32 |
GetFlatgrammCompanyRelationCountRequest¶
Запрос получения количества связей квартирограмм и компаний
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр связей квартирограмм и компании | keyapis.access_control.v1.FlatgrammCompanyRelationFilter |
GetFlatgrammCompanyRelationCountResponse¶
Ответ на запрос получения количества связей квартирограмм и компаний
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| error | Ошибка | optional keyapis.access_control.v1.GetFlatgrammCompanyRelationCountResponse.Error | |
| data | Всего связей квартирограмм и компаний | optional int32 |
GetFlatgrammCompanyRelationCountResponse.Error¶
Ошибка
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.access_control.v1.ValidationError |
GetFlatgrammCompanyRelationListRequest¶
Запрос получения списка
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр связей квартирограмм и компаний | keyapis.access_control.v1.FlatgrammCompanyRelationFilter | |
| paging | Пагинация | optional keyapis.access_control.v1.FlatgrammCompanyRelationPaging |
GetFlatgrammCompanyRelationListResponse¶
Ответ на запрос получения списка связей квартирограмм и компаний
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| error | Ошибка | optional keyapis.access_control.v1.GetFlatgrammCompanyRelationListResponse.Error | |
| data | Связь квартирограммы и компании | optional keyapis.access_control.v1.FlatgrammCompanyRelation |
GetFlatgrammCompanyRelationListResponse.Error¶
Ошибка
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.access_control.v1.ValidationError |
GetFlatgrammCountRequest¶
Запрос получения количества упрощенных квартирограмм
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр | keyapis.access_control.v1.FlatgrammFilter |
GetFlatgrammCountResponse¶
Ответ на запрос получения количества упрощенных квартирограмм
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Всего упрощенных квартирограмм | optional int32 |
GetFlatgrammDcCompanyCountRequest¶
Deprecated. Запрос получения количества связей квартирограмм и домофонной компании
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр связей квартирограмм и домофонной компании | keyapis.access_control.v1.DcCompanyFlatgrammFilter |
GetFlatgrammDcCompanyCountResponse¶
Deprecated. Ответ на запрос получения количества связей квартирограмм и домофонной компании
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| error | Ошибка | optional keyapis.access_control.v1.GetFlatgrammDcCompanyCountResponse.Error | |
| data | Всего связей квартирограмм и домофонной компании | optional int32 |
GetFlatgrammDcCompanyCountResponse.Error¶
Ошибка
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.access_control.v1.ValidationError |
GetFlatgrammDcCompanyListRequest¶
Deprecated. Запрос получения списка
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр связей квартирограмм и домофонной компании | keyapis.access_control.v1.DcCompanyFlatgrammFilter | |
| paging | Пагинация | optional keyapis.access_control.v1.DcCompanyFlatgrammPaging |
GetFlatgrammDcCompanyListResponse¶
Deprecated. Ответ на запрос получения списка связей квартирограмм и домофонной компании
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| error | Ошибка | optional keyapis.access_control.v1.GetFlatgrammDcCompanyListResponse.Error | |
| data | Связь квартирограммы и домофонной компании | optional keyapis.access_control.v1.DcCompanyFlatgramm |
GetFlatgrammDcCompanyListResponse.Error¶
Ошибка
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.access_control.v1.ValidationError |
GetFlatgrammListRequest¶
Запрос на получение списка упрощенных квартирограмм
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр | keyapis.access_control.v1.FlatgrammFilter | |
| paging | Стандартный постраничный вывод | optional keyapis.access_control.v1.FlatgrammPaging |
GetFlatgrammListResponse¶
Ответ на запрос на получение списка упрощенных квартирограмм
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Упрощенная квартирограмма | optional keyapis.access_control.v1.Flatgramm | |
| error | Ошибка | optional keyapis.access_control.v1.GetFlatgrammListResponse.Error |
GetFlatgrammListResponse.Error¶
Ошибка запроса получения списка упрощенных квартирограмм
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.access_control.v1.ValidationError |
GetFlatgrammRequest¶
Запрос на получение упрощенной квартирограммы
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор | int32 | REQUIRED |
GetFlatgrammResponse¶
Ответ на запрос на получение упрощенной квартирограммы
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Упрощенная квартирограмма | optional keyapis.access_control.v1.Flatgramm | |
| error | Ошибка | optional keyapis.access_control.v1.GetFlatgrammResponse.Error |
GetFlatgrammResponse.Error¶
Ошибка запроса получения списка упрощенных квартирограмм
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.access_control.v1.ValidationError |
PutFlatgrammCompanyRelationAttachRequest¶
Запрос сохранения связей квартирограммы и компании
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| flatgramm_company_relation | Связь квартирограммы и компании | keyapis.access_control.v1.FlatgrammCompanyRelation | REQUIRED |
PutFlatgrammCompanyRelationAttachResponse¶
Ответ на запрос сохранения связи квартирограммы и компании
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| error | Ошибка | optional keyapis.access_control.v1.PutFlatgrammCompanyRelationAttachResponse.Error |
PutFlatgrammCompanyRelationAttachResponse.Error¶
Ошибка запроса сохранения связи квартирограммы и компании
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.access_control.v1.ValidationError |
PutFlatgrammCompanyRelationDetachRequest¶
Запрос удаления связей квартирограммы и компании
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| flatgramm_company_relation | Связь квартирограммы и компании | keyapis.access_control.v1.FlatgrammCompanyRelation | REQUIRED |
PutFlatgrammCompanyRelationDetachResponse¶
Ответ на запрос удаления связи квартирограммы и компании
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| error | Ошибка | optional keyapis.access_control.v1.PutFlatgrammCompanyRelationDetachResponse.Error |
PutFlatgrammCompanyRelationDetachResponse.Error¶
Ошибка запроса удаления связи квартирограммы и компании
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.access_control.v1.ValidationError |
PutFlatgrammDcCompanyAttachRequest¶
Deprecated. Запрос сохранения связей квартирограммы и домофонной компании
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| dc_company_flatgramm | Связь квартирограммы и домофонной компании | keyapis.access_control.v1.DcCompanyFlatgramm | REQUIRED |
PutFlatgrammDcCompanyAttachResponse¶
Deprecated. Ответ на запрос сохранения связи квартирограммы и домофонной компании
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| error | Ошибка | optional keyapis.access_control.v1.PutFlatgrammDcCompanyAttachResponse.Error |
PutFlatgrammDcCompanyAttachResponse.Error¶
Ошибка запроса сохранения связи квартирограммы и домофонной компании
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.access_control.v1.ValidationError |
PutFlatgrammDcCompanyDetachRequest¶
Deprecated. Запрос удаления связей квартирограммы и домофонной компании
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| dc_company_flatgramm | Связь квартирограммы и домофонной компании | keyapis.access_control.v1.DcCompanyFlatgramm | REQUIRED |
PutFlatgrammDcCompanyDetachResponse¶
Deprecated. Ответ на запрос удаления связи квартирограммы и домофонной компании
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| error | Ошибка | optional keyapis.access_control.v1.PutFlatgrammDcCompanyDetachResponse.Error |
PutFlatgrammDcCompanyDetachResponse.Error¶
Ошибка запроса удаления связи квартирограммы и домофонной компании
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.access_control.v1.ValidationError |
DcCompanyFlatgrammPaging.DirectionType¶
Справочник типов направлений сортировки
| Номер | Тип | Название |
|---|---|---|
| 0 | DIRECTION_TYPE_UNKNOWN | Значение не указано |
| 1 | DESC | От большего к меньшему |
| 2 | ASC | От меньшего к большему |
DcCompanyFlatgrammPaging.OrderByType¶
Справочник типов сортировки
| Номер | Тип | Название |
|---|---|---|
| 0 | ORDER_BY_TYPE_UNKNOWN | Значение не указано |
| 1 | COMPANY_ID | По Идентификатору домофонной компании |
| 2 | FLATGRAMM_ID | По Идентификатору квартирограммы |
FlatgrammCompanyRelation.Type¶
Тип связи компании и квартирограммы. По умолчанию OWNER.
Тип: byte¶
| Номер | Тип | Название |
|---|---|---|
| 0 | TYPE_UNKNOWN | Значение не указано |
| 1 | MANAGEMENT | Управляющая компания владеет квартирограммой |
| 2 | DEVICE_SERVICE | Домофонная компания обслуживает квартирограмму |
FlatgrammCompanyRelationPaging.DirectionType¶
Справочник типов направлений сортировки
| Номер | Тип | Название |
|---|---|---|
| 0 | DIRECTION_TYPE_UNKNOWN | Значение не указано |
| 1 | DESC | От большего к меньшему |
| 2 | ASC | От меньшего к большему |
FlatgrammCompanyRelationPaging.OrderByType¶
Справочник типов сортировки
| Номер | Тип | Название |
|---|---|---|
| 0 | ORDER_BY_TYPE_UNKNOWN | Значение не указано |
| 1 | COMPANY_ID | По Идентификатору компании |
| 2 | FLATGRAMM_ID | По Идентификатору квартирограммы |
FlatgrammPaging.DirectionType¶
Справочник типов направлений сортировки.
Тип: byte¶
| Номер | Тип | Название |
|---|---|---|
| 0 | DIRECTION_TYPE_UNKNOWN | Значение не указано |
| 1 | DESC | От большего к меньшему |
| 2 | ASC | От меньшего к большему |
FlatgrammPaging.OrderByType¶
Справочник типов значений сортировки.
Тип: byte¶
| Номер | Тип | Название |
|---|---|---|
| 0 | ORDER_BY_TYPE_UNKNOWN | Значение не указано |
| 1 | ID | По идентификатору |
| 2 | CREATED_AT | По времени создания |
| 3 | CHANGED_AT | По времени изменения |
| 4 | RANK | По рангу для поиска по тексту. Применяется когда передано поле для поиска по тексту. В случае если текстовое поле не передано, применяется значение по умолчанию |
Скалярные типы значений¶
| .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 |