frostfs-api/proto-docs/acl.md
alexvanin 5b8fecc93d docs: Add docs for new ACL package
This commit adds auto-generated proto-docs page and
ACL section in readme.
2020-04-01 21:02:46 +03:00

2.8 KiB

Protocol Documentation

Table of Contents

Top

acl/types.proto

Target

Target of the access control rule in access control list.

Name Number Description
Unknown 0 Unknown target, default value.
User 1 User target rule is applied if sender is the owner of the container.
System 2 System target rule is applied if sender is the storage node within the container or inner ring node.
Others 3 Others target rule is applied if sender is not user or system target.
PubKey 4 PubKey target rule is applied if sender has public key provided in extended ACL.

Scalar Value Types

.proto Type Notes C++ Type Java Type Python Type
double double double 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. int32 int int
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
uint32 Uses variable-length encoding. uint32 int int/long
uint64 Uses variable-length encoding. uint64 long int/long
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long
sfixed32 Always four bytes. int32 int int
sfixed64 Always eight bytes. int64 long int/long
bool bool boolean boolean
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode
bytes May contain any arbitrary sequence of bytes. string ByteString str