frostfs-api/proto-docs/refs.md

Protocol Documentation

Table of Contents

• refs/types.proto

  • Messages
    • Address
    • Checksum
    • ContainerID
    • ObjectID
    • OwnerID
    • Signature
    • Version

• Scalar Value Types

Top

refs/types.proto

Message Address

Address of object (container id + object id)

Field	Type	Label	Description
container_id	ContainerID		container_id carries container identifier.
object_id	ObjectID		object_id carries object identifier.

Message Checksum

Checksum message

Field	Type	Label	Description
type	ChecksumType		Checksum algorithm type
sum	bytes		Checksum itself

Message ContainerID

NeoFS container identifier.

Field	Type	Label	Description
value	bytes		value carries the container identifier in a binary format.

Message ObjectID

NeoFS object identifier.

Field	Type	Label	Description
value	bytes		value carries the object identifier in a binary format.

Message OwnerID

OwnerID group information about the owner of the NeoFS container.

Field	Type	Label	Description
value	bytes		value carries the identifier of the container owner in a binary format.

Message Signature

Signature of something in NeoFS

Field	Type	Label	Description
key	bytes		Public key used for signing.
sign	bytes		Signature

Message Version

Represents API version used by node.

Field	Type	Label	Description
major	uint32		Major API version.
minor	uint32		Minor API version.

ChecksumType

Checksum algorithm type

Name	Number	Description
CHECKSUM_TYPE_UNSPECIFIED	0	Unknown. Not used
TZ	1	Tillich-Zemor homomorphic hash funciton
SHA256	2	SHA-256

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