frostfs-api/proto-docs/netmap.md

Protocol Documentation

Table of Contents

• netmap/types.proto

  • Messages
    • NodeInfo
    • NodeInfo.Attribute
    • PlacementPolicy
    • PlacementPolicy.FilterGroup
    • PlacementPolicy.FilterGroup.Filter
    • PlacementPolicy.FilterGroup.Filter.SimpleFilter
    • PlacementPolicy.FilterGroup.Filter.SimpleFilter.SimpleFilters
    • PlacementPolicy.FilterGroup.Selector

• Scalar Value Types

Top

netmap/types.proto

Message NodeInfo

NeoFS node description

Field	Type	Label	Description
address	string		Ways to connect to a node
public_key	bytes		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

Attributes of the NeoFS node.

Field	Type	Label	Description
key	string		Key of the node attribute.
value	string		Value of the node attribute.

Message PlacementPolicy

Set of rules to select a subset of nodes able to store container's objects

Field	Type	Label	Description
repl_factor	uint32		Replication factor
filter_groups	PlacementPolicy.FilterGroup	repeated	List of filter groups

Message PlacementPolicy.FilterGroup

Filters to apply to Network Map

Field	Type	Label	Description
filters	PlacementPolicy.FilterGroup.Filter	repeated	Resulting filter list
selectors	PlacementPolicy.FilterGroup.Selector	repeated	List of selectors
exclude	uint32	repeated	Parts of graph to exclude. Internal use.

Message PlacementPolicy.FilterGroup.Filter

Filter definition

Field	Type	Label	Description
key	string		Filter identifier
f	PlacementPolicy.FilterGroup.Filter.SimpleFilter		The rest of filter

Message PlacementPolicy.FilterGroup.Filter.SimpleFilter

Minimal simple filter

Field	Type	Label	Description
op	PlacementPolicy.FilterGroup.Filter.SimpleFilter.Operation		Filtering operation
value	string		Value
f_args	PlacementPolicy.FilterGroup.Filter.SimpleFilter.SimpleFilters		Result of other filter application

Message PlacementPolicy.FilterGroup.Filter.SimpleFilter.SimpleFilters

List of filters

Field	Type	Label	Description
filters	PlacementPolicy.FilterGroup.Filter.SimpleFilter	repeated	List of filters

Message PlacementPolicy.FilterGroup.Selector

Selector

Field	Type	Label	Description
count	uint32		How many to select
key	string		Key to select

NodeInfo.State

Represents the enumeration of various states of the NeoFS node.

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

PlacementPolicy.FilterGroup.Filter.SimpleFilter.Operation

Filtering operation

Name	Number	Description
OPERATION_UNSPECIFIED	0	No Operation defined
EQ	1	Equal
NE	2	Not Equal
GT	3	Greater then
GE	4	Greater or equal
LT	5	Less then
LE	6	Less or equal
OR	7	Logical OR
AND	8	Logical AND

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