diff --git a/netmap/types.proto b/netmap/types.proto new file mode 100644 index 0000000..a0e4026 --- /dev/null +++ b/netmap/types.proto @@ -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; +} diff --git a/proto-docs/netmap.md b/proto-docs/netmap.md new file mode 100644 index 0000000..e961682 --- /dev/null +++ b/proto-docs/netmap.md @@ -0,0 +1,146 @@ +# Protocol Documentation + + +## 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) + + + + +
+ +## netmap/types.proto + + + + + + + +### Message PlacementRule + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ReplFactor | [uint32](#uint32) | | | +| SFGroups | [PlacementRule.SFGroup](#netmap.PlacementRule.SFGroup) | repeated | | + + + + +### 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 | | + + + + +### Message PlacementRule.SFGroup.Filter + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| Key | [string](#string) | | | +| F | [PlacementRule.SFGroup.Filter.SimpleFilter](#netmap.PlacementRule.SFGroup.Filter.SimpleFilter) | | | + + + + +### 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) | | | + + + + +### Message PlacementRule.SFGroup.Filter.SimpleFilters + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| Filters | [PlacementRule.SFGroup.Filter.SimpleFilter](#netmap.PlacementRule.SFGroup.Filter.SimpleFilter) | repeated | | + + + + +### Message PlacementRule.SFGroup.Selector + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| Count | [uint32](#uint32) | | | +| Key | [string](#string) | | | + + + + + + +### 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 | +