forked from TrueCloudLab/frostfs-api
87 lines
3.1 KiB
Markdown
87 lines
3.1 KiB
Markdown
# Protocol Documentation
|
|
<a name="top"></a>
|
|
|
|
## Table of Contents
|
|
|
|
- [ape/types.proto](#ape/types.proto)
|
|
|
|
- Messages
|
|
- [Chain](#frost.fs.ape.Chain)
|
|
- [ChainTarget](#frost.fs.ape.ChainTarget)
|
|
|
|
|
|
- [Scalar Value Types](#scalar-value-types)
|
|
|
|
|
|
|
|
<a name="ape/types.proto"></a>
|
|
<p align="right"><a href="#top">Top</a></p>
|
|
|
|
## ape/types.proto
|
|
|
|
|
|
<!-- end services -->
|
|
|
|
|
|
<a name="frost.fs.ape.Chain"></a>
|
|
|
|
### Message Chain
|
|
Chain is a chain of rules defined for a specific target.
|
|
|
|
|
|
| Field | Type | Label | Description |
|
|
| ----- | ---- | ----- | ----------- |
|
|
| raw | [bytes](#bytes) | | Raw representation of a serizalized rule chain. |
|
|
|
|
|
|
<a name="frost.fs.ape.ChainTarget"></a>
|
|
|
|
### Message ChainTarget
|
|
ChainTarget is an object to which a rule chain is defined.
|
|
|
|
|
|
| Field | Type | Label | Description |
|
|
| ----- | ---- | ----- | ----------- |
|
|
| type | [TargetType](#frost.fs.ape.TargetType) | | |
|
|
| name | [string](#string) | | |
|
|
|
|
<!-- end messages -->
|
|
|
|
|
|
<a name="frost.fs.ape.TargetType"></a>
|
|
|
|
### TargetType
|
|
TargetType is a type target to which a rule chain is defined.
|
|
|
|
| Name | Number | Description |
|
|
| ---- | ------ | ----------- |
|
|
| UNDEFINED | 0 | |
|
|
| NAMESPACE | 1 | |
|
|
| CONTAINER | 2 | |
|
|
| USER | 3 | |
|
|
| GROUP | 4 | |
|
|
|
|
|
|
<!-- end enums -->
|
|
|
|
|
|
|
|
## Scalar Value Types
|
|
|
|
| .proto Type | Notes | C++ Type | Java Type | Python Type |
|
|
| ----------- | ----- | -------- | --------- | ----------- |
|
|
| <a name="double" /> double | | double | double | float |
|
|
| <a name="float" /> float | | float | float | float |
|
|
| <a name="int32" /> int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int |
|
|
| <a name="int64" /> int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long |
|
|
| <a name="uint32" /> uint32 | Uses variable-length encoding. | uint32 | int | int/long |
|
|
| <a name="uint64" /> uint64 | Uses variable-length encoding. | uint64 | long | int/long |
|
|
| <a name="sint32" /> sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int |
|
|
| <a name="sint64" /> sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long |
|
|
| <a name="fixed32" /> fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int |
|
|
| <a name="fixed64" /> fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long |
|
|
| <a name="sfixed32" /> sfixed32 | Always four bytes. | int32 | int | int |
|
|
| <a name="sfixed64" /> sfixed64 | Always eight bytes. | int64 | long | int/long |
|
|
| <a name="bool" /> bool | | bool | boolean | boolean |
|
|
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode |
|
|
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str |
|