forked from TrueCloudLab/frostfs-api
[#34] Add netmap package
Introduce netmap package to repository. Also as initial use, added container storage rules message netmap.PlacementRule. Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
This commit is contained in:
Leonard Lyubich
Stanislav Bogatyrev
parent
44ec19962a
commit
f60273beb9
2 changed files with 202 additions and 0 deletions
56
netmap/types.proto
Normal file
56
netmap/types.proto
Normal file
|
|
@ -0,0 +1,56 @@
|
||||||
|
syntax = "proto3";
|
||||||
|
|
||||||
|
package netmap;
|
||||||
|
|
||||||
|
option go_package = "github.com/nspcc-dev/neofs-api-go/netmap";
|
||||||
|
option csharp_namespace = "NeoFS.API.Netmap";
|
||||||
|
|
||||||
|
message PlacementRule {
|
||||||
|
uint32 ReplFactor = 1;
|
||||||
|
|
||||||
|
message SFGroup {
|
||||||
|
message Filter {
|
||||||
|
string Key = 1;
|
||||||
|
|
||||||
|
message SimpleFilters {
|
||||||
|
repeated SimpleFilter Filters = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
message SimpleFilter {
|
||||||
|
enum Operation {
|
||||||
|
NP = 0;
|
||||||
|
EQ = 1;
|
||||||
|
NE = 2;
|
||||||
|
GT = 3;
|
||||||
|
GE = 4;
|
||||||
|
LT = 5;
|
||||||
|
LE = 6;
|
||||||
|
OR = 7;
|
||||||
|
AND = 8;
|
||||||
|
}
|
||||||
|
|
||||||
|
Operation Op = 1;
|
||||||
|
|
||||||
|
oneof Args {
|
||||||
|
string Value = 2;
|
||||||
|
SimpleFilters FArgs = 3;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
SimpleFilter F = 2;
|
||||||
|
}
|
||||||
|
|
||||||
|
repeated Filter Filters = 1;
|
||||||
|
|
||||||
|
message Selector {
|
||||||
|
uint32 Count = 1;
|
||||||
|
string Key = 2;
|
||||||
|
}
|
||||||
|
|
||||||
|
repeated Selector Selectors = 2;
|
||||||
|
|
||||||
|
repeated uint32 Exclude = 3;
|
||||||
|
}
|
||||||
|
|
||||||
|
repeated SFGroup SFGroups = 2;
|
||||||
|
}
|
||||||
146
proto-docs/netmap.md
Normal file
146
proto-docs/netmap.md
Normal file
|
|
@ -0,0 +1,146 @@
|
||||||
|
# Protocol Documentation
|
||||||
|
<a name="top"></a>
|
||||||
|
|
||||||
|
## Table of Contents
|
||||||
|
|
||||||
|
- [netmap/types.proto](#netmap/types.proto)
|
||||||
|
|
||||||
|
- Messages
|
||||||
|
- [PlacementRule](#netmap.PlacementRule)
|
||||||
|
- [PlacementRule.SFGroup](#netmap.PlacementRule.SFGroup)
|
||||||
|
- [PlacementRule.SFGroup.Filter](#netmap.PlacementRule.SFGroup.Filter)
|
||||||
|
- [PlacementRule.SFGroup.Filter.SimpleFilter](#netmap.PlacementRule.SFGroup.Filter.SimpleFilter)
|
||||||
|
- [PlacementRule.SFGroup.Filter.SimpleFilters](#netmap.PlacementRule.SFGroup.Filter.SimpleFilters)
|
||||||
|
- [PlacementRule.SFGroup.Selector](#netmap.PlacementRule.SFGroup.Selector)
|
||||||
|
|
||||||
|
|
||||||
|
- [Scalar Value Types](#scalar-value-types)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="netmap/types.proto"></a>
|
||||||
|
<p align="right"><a href="#top">Top</a></p>
|
||||||
|
|
||||||
|
## netmap/types.proto
|
||||||
|
|
||||||
|
|
||||||
|
<!-- end services -->
|
||||||
|
|
||||||
|
|
||||||
|
<a name="netmap.PlacementRule"></a>
|
||||||
|
|
||||||
|
### Message PlacementRule
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| ReplFactor | [uint32](#uint32) | | |
|
||||||
|
| SFGroups | [PlacementRule.SFGroup](#netmap.PlacementRule.SFGroup) | repeated | |
|
||||||
|
|
||||||
|
|
||||||
|
<a name="netmap.PlacementRule.SFGroup"></a>
|
||||||
|
|
||||||
|
### Message PlacementRule.SFGroup
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| Filters | [PlacementRule.SFGroup.Filter](#netmap.PlacementRule.SFGroup.Filter) | repeated | |
|
||||||
|
| Selectors | [PlacementRule.SFGroup.Selector](#netmap.PlacementRule.SFGroup.Selector) | repeated | |
|
||||||
|
| Exclude | [uint32](#uint32) | repeated | |
|
||||||
|
|
||||||
|
|
||||||
|
<a name="netmap.PlacementRule.SFGroup.Filter"></a>
|
||||||
|
|
||||||
|
### Message PlacementRule.SFGroup.Filter
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| Key | [string](#string) | | |
|
||||||
|
| F | [PlacementRule.SFGroup.Filter.SimpleFilter](#netmap.PlacementRule.SFGroup.Filter.SimpleFilter) | | |
|
||||||
|
|
||||||
|
|
||||||
|
<a name="netmap.PlacementRule.SFGroup.Filter.SimpleFilter"></a>
|
||||||
|
|
||||||
|
### Message PlacementRule.SFGroup.Filter.SimpleFilter
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| Op | [PlacementRule.SFGroup.Filter.SimpleFilter.Operation](#netmap.PlacementRule.SFGroup.Filter.SimpleFilter.Operation) | | |
|
||||||
|
| Value | [string](#string) | | |
|
||||||
|
| FArgs | [PlacementRule.SFGroup.Filter.SimpleFilters](#netmap.PlacementRule.SFGroup.Filter.SimpleFilters) | | |
|
||||||
|
|
||||||
|
|
||||||
|
<a name="netmap.PlacementRule.SFGroup.Filter.SimpleFilters"></a>
|
||||||
|
|
||||||
|
### Message PlacementRule.SFGroup.Filter.SimpleFilters
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| Filters | [PlacementRule.SFGroup.Filter.SimpleFilter](#netmap.PlacementRule.SFGroup.Filter.SimpleFilter) | repeated | |
|
||||||
|
|
||||||
|
|
||||||
|
<a name="netmap.PlacementRule.SFGroup.Selector"></a>
|
||||||
|
|
||||||
|
### Message PlacementRule.SFGroup.Selector
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| Count | [uint32](#uint32) | | |
|
||||||
|
| Key | [string](#string) | | |
|
||||||
|
|
||||||
|
<!-- end messages -->
|
||||||
|
|
||||||
|
|
||||||
|
<a name="netmap.PlacementRule.SFGroup.Filter.SimpleFilter.Operation"></a>
|
||||||
|
|
||||||
|
### 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 | |
|
||||||
|
|
||||||
|
|
||||||
|
<!-- end enums -->
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Scalar Value Types
|
||||||
|
|
||||||
|
| .proto Type | Notes | C++ Type | Java Type | Python Type |
|
||||||
|
| ----------- | ----- | -------- | --------- | ----------- |
|
||||||
|
| <a name="double" /> double | | double | double | float |
|
||||||
|
| <a name="float" /> float | | float | float | float |
|
||||||
|
| <a name="int32" /> 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 |
|
||||||
|
| <a name="int64" /> 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 |
|
||||||
|
| <a name="uint32" /> uint32 | Uses variable-length encoding. | uint32 | int | int/long |
|
||||||
|
| <a name="uint64" /> uint64 | Uses variable-length encoding. | uint64 | long | int/long |
|
||||||
|
| <a name="sint32" /> sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int |
|
||||||
|
| <a name="sint64" /> sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long |
|
||||||
|
| <a name="fixed32" /> fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int |
|
||||||
|
| <a name="fixed64" /> fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long |
|
||||||
|
| <a name="sfixed32" /> sfixed32 | Always four bytes. | int32 | int | int |
|
||||||
|
| <a name="sfixed64" /> sfixed64 | Always eight bytes. | int64 | long | int/long |
|
||||||
|
| <a name="bool" /> bool | | bool | boolean | boolean |
|
||||||
|
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode |
|
||||||
|
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str |
|
||||||
|
|
||||||
Loading…
Reference in a new issue