frostfs-api/proto-docs/netmap.md

Protocol Documentation

Table of Contents

• netmap/types.proto

  • Messages
    • NodeInfo
    • NodeInfo.Attribute
    • PlacementRule
    • PlacementRule.SFGroup
    • PlacementRule.SFGroup.Filter
    • PlacementRule.SFGroup.Filter.SimpleFilter
    • PlacementRule.SFGroup.Filter.SimpleFilters
    • PlacementRule.SFGroup.Selector

• Scalar Value Types

Top

netmap/types.proto

Message NodeInfo

Groups the information about the NeoFS node.

Field	Type	Label	Description
address	string		Carries network address of the NeoFS node.
public_key	bytes		Carries public key of the NeoFS node in a binary format.
attributes	NodeInfo.Attribute	repeated	Carries list of the NeoFS node attributes in a string key-value format.
state	NodeInfo.State		Carries state of the NeoFS node.

Message NodeInfo.Attribute

Groups attributes of the NeoFS node.

Field	Type	Label	Description
key	string		Carries string key to the node attribute.
value	string		Carries string value of the node attribute.

Message PlacementRule

Field	Type	Label	Description
repl_factor	uint32
sf_groups	PlacementRule.SFGroup	repeated

Message PlacementRule.SFGroup

Field	Type	Label	Description
filters	PlacementRule.SFGroup.Filter	repeated
selectors	PlacementRule.SFGroup.Selector	repeated
exclude	uint32	repeated

Message PlacementRule.SFGroup.Filter

Field	Type	Label	Description
key	string
f	PlacementRule.SFGroup.Filter.SimpleFilter

Message PlacementRule.SFGroup.Filter.SimpleFilter

Field	Type	Label	Description
op	PlacementRule.SFGroup.Filter.SimpleFilter.Operation
value	string
f_args	PlacementRule.SFGroup.Filter.SimpleFilters

Message PlacementRule.SFGroup.Filter.SimpleFilters

Field	Type	Label	Description
filters	PlacementRule.SFGroup.Filter.SimpleFilter	repeated

Message PlacementRule.SFGroup.Selector

Field	Type	Label	Description
count	uint32
key	string

NodeInfo.State

Represents the enumeration of various states of the NeoFS node.

Name	Number	Description
UNKNOWN	0	Undefined state.
ONLINE	1	Active state in the network.
OFFLINE	2	Network unavailable state.

PlacementRule.SFGroup.Filter.SimpleFilter.Operation

Name	Number	Description
NP	0
EQ	1
NE	2
GT	3
GE	4
LT	5
LE	6
OR	7
AND	8

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