frostfs-api/proto-docs/storagegroup.md

Protocol Documentation

Table of Contents

• storagegroup/types.proto

  • Messages
    • StorageGroup
    • StorageGroup.Lifetime

• Scalar Value Types

Top

storagegroup/types.proto

Message StorageGroup

Field	Type	Label	Description
ValidationDataSize	uint64		ValidationDataSize is size of the all object's payloads included into storage group
ValidationHash	bytes		ValidationHash is homomorphic hash of all object's payloads included into storage group
lifetime	StorageGroup.Lifetime		Lifetime is time until storage group is valid
Members	refs.ObjectID	repeated	Members carries the list of identifiers of the object storage group members. The list is strictly ordered.

Message StorageGroup.Lifetime

Field	Type	Label	Description
unit	StorageGroup.Lifetime.Unit		Unit is lifetime type
Value	int64		Value for lifetime

StorageGroup.Lifetime.Unit

Name	Number	Description
Unlimited	0	Unlimited set if storage group always valid
NeoFSEpoch	1	NeoFSEpoch set if storage group is valid until lifetime NeoFS epoch
UnixTime	2	UnixTime set if storage group is valid until lifetime unix timestamp

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