frostfs-api/proto-docs/storagegroup.md
Stanislav Bogatyrev eb61f7cafd [#45] docs: Regenerate Markdown docs
Signed-off-by: Stanislav Bogatyrev <stanislav@nspcc.ru>
2020-08-13 22:57:00 +03:00

3.3 KiB

Protocol Documentation

Table of Contents

Top

storagegroup/types.proto

Message StorageGroup

StorageGroup groups the information about the NeoFS storage group. The storage group consists of objects from single container.

Field Type Label Description
validation_data_size uint64 validation_data_size carries the total size of the payloads of the storage group members.
validation_hash bytes validation_hash carries homomorphic hash from the concatenation of the payloads of the storage group members The order of concatenation is the same as the order of the members in the Members field.
expiration_epoch uint64 expiration_epoch carries last NeoFS epoch number of the storage group lifetime.
members neo.fs.v2.refs.ObjectID repeated Members carries the list of identifiers of the object storage group members. The list is strictly ordered.

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