dstepanov-yadro/frostfs-api
1
0
Fork 0
forked from TrueCloudLab/frostfs-api
Code Pull requests Activity
frostfs-api/proto-docs/object.md

534 lines
20 KiB
Markdown
Raw Normal View History

initialize
2020-01-30 11:41:24 +00:00
# Protocol Documentation
<a name="top"></a>
## Table of Contents
- [object/service.proto](#object/service.proto)
- Services
- [Service](#object.Service)
- Messages
- [DeleteRequest](#object.DeleteRequest)
- [DeleteResponse](#object.DeleteResponse)
- [GetRangeHashRequest](#object.GetRangeHashRequest)
- [GetRangeHashResponse](#object.GetRangeHashResponse)
- [GetRangeRequest](#object.GetRangeRequest)
- [GetRangeResponse](#object.GetRangeResponse)
- [GetRequest](#object.GetRequest)
- [GetResponse](#object.GetResponse)
- [HeadRequest](#object.HeadRequest)
- [HeadResponse](#object.HeadResponse)
- [PutRequest](#object.PutRequest)
- [PutRequest.PutHeader](#object.PutRequest.PutHeader)
- [PutResponse](#object.PutResponse)
[#26] object: Replace object.Range message definition This commit replaces Range message definition closer to where it is used. In the future, only the types associated with the structure of the object will be defined in types.proto file. Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-04 08:43:34 +00:00
- [Range](#object.Range)
initialize
2020-01-30 11:41:24 +00:00
- [SearchRequest](#object.SearchRequest)
- [SearchResponse](#object.SearchResponse)
- [object/types.proto](#object/types.proto)
- Messages
[#26] object: Rename UserHeader to Attribute The name of object.UserHeader message implies its use by the user. However, the attributes of an object can also be set internally by the system. To generalize the intended purpose of the message, this commit renames it to an Attribute (like container.Attribute). Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-04 09:53:33 +00:00
- [Attribute](#object.Attribute)
[#26] object: Rename Header to ExtendedHeader The naming Header obscures its semantic meaning precisely as a subclass of the general object header. To clarify the layers of typing object headers, this commit renames the message to ExtendedHeader. As a result, the Headers field in the Object has been renamed to ExtendedHeaders. Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-04 10:04:45 +00:00
- [ExtendedHeader](#object.ExtendedHeader)
[#26] object: Define message for object header In previous version of the format Object message included two header fields: SystemHeader and list of ExtendedHeader. Due to the fact that all headers were not encapsulated in a single message, some messages were forced to use Object to convey the full header of the object (e.g. object.HeadResponse). To resolve this semantic inconsistency, this commit defines a Header message, consisting of a system and an extended portion. As a result, the Object now consists of two fields - Header and Payload. Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-04 10:18:38 +00:00
- [Header](#object.Header)
initialize
2020-01-30 11:41:24 +00:00
- [IntegrityHeader](#object.IntegrityHeader)
- [Link](#object.Link)
- [Object](#object.Object)
- [PublicKey](#object.PublicKey)
[#26] object: Define object split info message This commit defines SplitHeader message that encapsulates data about spawning the object through a payload splitting. Message fields contain information about the hierarchy in the split-chain as well as information about the origin object. Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-04 13:04:56 +00:00
- [SplitHeader](#object.SplitHeader)
initialize
2020-01-30 11:41:24 +00:00
- [SystemHeader](#object.SystemHeader)
- [Tombstone](#object.Tombstone)
- [Scalar Value Types](#scalar-value-types)
<a name="object/service.proto"></a>
<p align="right"><a href="#top">Top</a></p>
## object/service.proto
<a name="object.Service"></a>
### Service "object.Service"
Object service provides API for manipulating with the object.
```
rpc Get(GetRequest) returns (stream GetResponse);
rpc Put(stream PutRequest) returns (PutResponse);
rpc Delete(DeleteRequest) returns (DeleteResponse);
rpc Head(HeadRequest) returns (HeadResponse);
make object.Search to be server-side streaming RPC
2020-02-03 09:08:18 +00:00
rpc Search(SearchRequest) returns (stream SearchResponse);
make object.GetRange to be server-side streaming RPC
2020-02-05 10:38:53 +00:00
rpc GetRange(GetRangeRequest) returns (stream GetRangeResponse);
initialize
2020-01-30 11:41:24 +00:00
rpc GetRangeHash(GetRangeHashRequest) returns (GetRangeHashResponse);
```
#### Method Get
Get the object from container. Response uses gRPC stream. First response
message carry object of requested address. Chunk messages are parts of
the object's payload if it is needed. All messages except first carry
chunks. Requested object can be restored by concatenation of object
message payload and all chunks keeping receiving order.
| Name | Input | Output |
| ---- | ----- | ------ |
| Get | [GetRequest](#object.GetRequest) | [GetResponse](#object.GetResponse) |
#### Method Put
Put the object into container. Request uses gRPC stream. First message
SHOULD BE type of PutHeader. Container id and Owner id of object SHOULD
BE set. Session token SHOULD BE obtained before put operation (see
session package). Chunk messages considered by server as part of object
payload. All messages except first SHOULD BE chunks. Chunk messages
SHOULD BE sent in direct order of fragmentation.
| Name | Input | Output |
| ---- | ----- | ------ |
| Put | [PutRequest](#object.PutRequest) | [PutResponse](#object.PutResponse) |
#### Method Delete
Delete the object from a container
| Name | Input | Output |
| ---- | ----- | ------ |
| Delete | [DeleteRequest](#object.DeleteRequest) | [DeleteResponse](#object.DeleteResponse) |
#### Method Head
Head returns the object without data payload. Object in the
response has system header only. If full headers flag is set, extended
headers are also present.
| Name | Input | Output |
| ---- | ----- | ------ |
| Head | [HeadRequest](#object.HeadRequest) | [HeadResponse](#object.HeadResponse) |
#### Method Search
Search objects in container. Version of query language format SHOULD BE
set to 1. Search query represented in serialized format (see query
update proto docs
2020-03-31 07:17:52 +00:00
package).
initialize
2020-01-30 11:41:24 +00:00
| Name | Input | Output |
| ---- | ----- | ------ |
| Search | [SearchRequest](#object.SearchRequest) | [SearchResponse](#object.SearchResponse) |
#### Method GetRange
make object.GetRange to be server-side streaming RPC
2020-02-05 10:38:53 +00:00
GetRange of data payload. Range is a pair (offset, length).
update proto docs
2020-03-31 07:17:52 +00:00
Requested range can be restored by concatenation of all chunks
keeping receiving order.
initialize
2020-01-30 11:41:24 +00:00
| Name | Input | Output |
| ---- | ----- | ------ |
| GetRange | [GetRangeRequest](#object.GetRangeRequest) | [GetRangeResponse](#object.GetRangeResponse) |
#### Method GetRangeHash
GetRangeHash returns homomorphic hash of object payload range after XOR
operation. Ranges are set of pairs (offset, length). Hashes order in
response corresponds to ranges order in request. Homomorphic hash is
calculated for XORed data.
| Name | Input | Output |
| ---- | ----- | ------ |
| GetRangeHash | [GetRangeHashRequest](#object.GetRangeHashRequest) | [GetRangeHashResponse](#object.GetRangeHashResponse) |
<!-- end services -->
<a name="object.DeleteRequest"></a>
### Message DeleteRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| Address | [refs.Address](#refs.Address) | | Address of object (container id + object id) |
| OwnerID | [bytes](#bytes) | | OwnerID is a wallet address |
| Meta | [service.RequestMetaHeader](#service.RequestMetaHeader) | | RequestMetaHeader contains information about request meta headers (should be embedded into message) |
| Verify | [service.RequestVerificationHeader](#service.RequestVerificationHeader) | | RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request (should be embedded into message) |
<a name="object.DeleteResponse"></a>
### Message DeleteResponse
DeleteResponse is empty because we cannot guarantee permanent object removal
in distributed system.
update proto docs
2020-03-31 07:17:52 +00:00
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| Meta | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | ResponseMetaHeader contains meta information based on request processing by server (should be embedded into message) |
initialize
2020-01-30 11:41:24 +00:00
<a name="object.GetRangeHashRequest"></a>
### Message GetRangeHashRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| Address | [refs.Address](#refs.Address) | | Address of object (container id + object id) |
| Ranges | [Range](#object.Range) | repeated | Ranges of object's payload to calculate homomorphic hash |
| Salt | [bytes](#bytes) | | Salt is used to XOR object's payload ranges before hashing, it can be nil |
| Meta | [service.RequestMetaHeader](#service.RequestMetaHeader) | | RequestMetaHeader contains information about request meta headers (should be embedded into message) |
| Verify | [service.RequestVerificationHeader](#service.RequestVerificationHeader) | | RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request (should be embedded into message) |
<a name="object.GetRangeHashResponse"></a>
### Message GetRangeHashResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| Hashes | [bytes](#bytes) | repeated | Hashes is a homomorphic hashes of all ranges |
update proto docs
2020-03-31 07:17:52 +00:00
| Meta | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | ResponseMetaHeader contains meta information based on request processing by server (should be embedded into message) |
initialize
2020-01-30 11:41:24 +00:00
<a name="object.GetRangeRequest"></a>
### Message GetRangeRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| Address | [refs.Address](#refs.Address) | | Address of object (container id + object id) |
update GetRangeRequest docs
2020-02-05 11:23:14 +00:00
| Range | [Range](#object.Range) | | Range of object's payload to return |
initialize
2020-01-30 11:41:24 +00:00
| Meta | [service.RequestMetaHeader](#service.RequestMetaHeader) | | RequestMetaHeader contains information about request meta headers (should be embedded into message) |
| Verify | [service.RequestVerificationHeader](#service.RequestVerificationHeader) | | RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request (should be embedded into message) |
<a name="object.GetRangeResponse"></a>
### Message GetRangeResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
change GetRangeResponse type from 'repeated bytes' to 'bytes'
2020-02-05 11:21:15 +00:00
| Fragment | [bytes](#bytes) | | Fragment of object's payload |
update proto docs
2020-03-31 07:17:52 +00:00
| Meta | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | ResponseMetaHeader contains meta information based on request processing by server (should be embedded into message) |
initialize
2020-01-30 11:41:24 +00:00
<a name="object.GetRequest"></a>
### Message GetRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| Address | [refs.Address](#refs.Address) | | Address of object (container id + object id) |
| Meta | [service.RequestMetaHeader](#service.RequestMetaHeader) | | RequestMetaHeader contains information about request meta headers (should be embedded into message) |
| Verify | [service.RequestVerificationHeader](#service.RequestVerificationHeader) | | RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request (should be embedded into message) |
<a name="object.GetResponse"></a>
### Message GetResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| object | [Object](#object.Object) | | Object header and some payload |
| Chunk | [bytes](#bytes) | | Chunk of remaining payload |
update proto docs
2020-03-31 07:17:52 +00:00
| Meta | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | ResponseMetaHeader contains meta information based on request processing by server (should be embedded into message) |
initialize
2020-01-30 11:41:24 +00:00
<a name="object.HeadRequest"></a>
### Message HeadRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| Address | [refs.Address](#refs.Address) | | Address of object (container id + object id) |
| FullHeaders | [bool](#bool) | | FullHeaders can be set true for extended headers in the object |
| Meta | [service.RequestMetaHeader](#service.RequestMetaHeader) | | RequestMetaHeader contains information about request meta headers (should be embedded into message) |
| Verify | [service.RequestVerificationHeader](#service.RequestVerificationHeader) | | RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request (should be embedded into message) |
<a name="object.HeadResponse"></a>
### Message HeadResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| Object | [Object](#object.Object) | | Object without payload |
update proto docs
2020-03-31 07:17:52 +00:00
| Meta | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | ResponseMetaHeader contains meta information based on request processing by server (should be embedded into message) |
initialize
2020-01-30 11:41:24 +00:00
<a name="object.PutRequest"></a>
### Message PutRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| Header | [PutRequest.PutHeader](#object.PutRequest.PutHeader) | | Header should be the first message in the stream |
| Chunk | [bytes](#bytes) | | Chunk should be a remaining message in stream should be chunks |
| Meta | [service.RequestMetaHeader](#service.RequestMetaHeader) | | RequestMetaHeader contains information about request meta headers (should be embedded into message) |
| Verify | [service.RequestVerificationHeader](#service.RequestVerificationHeader) | | RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request (should be embedded into message) |
<a name="object.PutRequest.PutHeader"></a>
### Message PutRequest.PutHeader
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| Object | [Object](#object.Object) | | Object with at least container id and owner id fields |
docs: regenerate files
2020-04-20 09:04:39 +00:00
| CopiesNumber | [uint32](#uint32) | | Number of the object copies to store within the RPC call (zero is processed according to the placement rules) |
initialize
2020-01-30 11:41:24 +00:00
<a name="object.PutResponse"></a>
### Message PutResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| Address | [refs.Address](#refs.Address) | | Address of object (container id + object id) |
update proto docs
2020-03-31 07:17:52 +00:00
| Meta | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | ResponseMetaHeader contains meta information based on request processing by server (should be embedded into message) |
initialize
2020-01-30 11:41:24 +00:00
[#26] object: Replace object.Range message definition This commit replaces Range message definition closer to where it is used. In the future, only the types associated with the structure of the object will be defined in types.proto file. Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-04 08:43:34 +00:00
<a name="object.Range"></a>
### Message Range
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| Offset | [uint64](#uint64) | | Offset of the data range |
| Length | [uint64](#uint64) | | Length of the data range |
initialize
2020-01-30 11:41:24 +00:00
<a name="object.SearchRequest"></a>
### Message SearchRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| ContainerID | [bytes](#bytes) | | ContainerID for searching the object |
| Query | [bytes](#bytes) | | Query in the binary serialized format |
| QueryVersion | [uint32](#uint32) | | QueryVersion is a version of search query format |
| Meta | [service.RequestMetaHeader](#service.RequestMetaHeader) | | RequestMetaHeader contains information about request meta headers (should be embedded into message) |
| Verify | [service.RequestVerificationHeader](#service.RequestVerificationHeader) | | RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request (should be embedded into message) |
<a name="object.SearchResponse"></a>
### Message SearchResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| Addresses | [refs.Address](#refs.Address) | repeated | Addresses of found objects |
update proto docs
2020-03-31 07:17:52 +00:00
| Meta | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | ResponseMetaHeader contains meta information based on request processing by server (should be embedded into message) |
initialize
2020-01-30 11:41:24 +00:00
<!-- end messages -->
<!-- end enums -->
<a name="object/types.proto"></a>
<p align="right"><a href="#top">Top</a></p>
## object/types.proto
<!-- end services -->
[#26] object: Rename UserHeader to Attribute The name of object.UserHeader message implies its use by the user. However, the attributes of an object can also be set internally by the system. To generalize the intended purpose of the message, this commit renames it to an Attribute (like container.Attribute). Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-04 09:53:33 +00:00
<a name="object.Attribute"></a>
### Message Attribute
Attribute groups the parameters of the object attributes.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| Key | [string](#string) | | Key carries the string key to the object attribute. |
| Value | [string](#string) | | Value carries the string value of the object attribute. |
[#26] object: Rename Header to ExtendedHeader The naming Header obscures its semantic meaning precisely as a subclass of the general object header. To clarify the layers of typing object headers, this commit renames the message to ExtendedHeader. As a result, the Headers field in the Object has been renamed to ExtendedHeaders. Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-04 10:04:45 +00:00
<a name="object.ExtendedHeader"></a>
initialize
2020-01-30 11:41:24 +00:00
[#26] object: Rename Header to ExtendedHeader The naming Header obscures its semantic meaning precisely as a subclass of the general object header. To clarify the layers of typing object headers, this commit renames the message to ExtendedHeader. As a result, the Headers field in the Object has been renamed to ExtendedHeaders. Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-04 10:04:45 +00:00
### Message ExtendedHeader
initialize
2020-01-30 11:41:24 +00:00
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| Link | [Link](#object.Link) | | Link to other objects |
| Redirect | [refs.Address](#refs.Address) | | Redirect not used yet |
[#26] object: Rename UserHeader to Attribute The name of object.UserHeader message implies its use by the user. However, the attributes of an object can also be set internally by the system. To generalize the intended purpose of the message, this commit renames it to an Attribute (like container.Attribute). Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-04 09:53:33 +00:00
| Attribute | [Attribute](#object.Attribute) | | Attribute is a set of K-V object attributes |
[#26] object: Replace Transform header with Split This commit replaces Transform message with SplitHeader in oneof definition of Value field of Header message. The latter, unlike the first, carries complete information about the generation of the object by splitting the payload. As a result, the message is deleted as no longer used. Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-04 13:50:29 +00:00
| SplitHeader | [SplitHeader](#object.SplitHeader) | | Split carries the position of the object in the split hierarchy. |
initialize
2020-01-30 11:41:24 +00:00
| Tombstone | [Tombstone](#object.Tombstone) | | Tombstone header that set up in deleted objects |
docs: regenerate
2020-04-27 10:14:31 +00:00
| Token | [service.Token](#service.Token) | | Token header contains token of the session within which the object was created |
initialize
2020-01-30 11:41:24 +00:00
| HomoHash | [bytes](#bytes) | | HomoHash is a homomorphic hash of original object payload |
| PayloadChecksum | [bytes](#bytes) | | PayloadChecksum of actual object's payload |
| Integrity | [IntegrityHeader](#object.IntegrityHeader) | | Integrity header with checksum of all above headers in the object |
| StorageGroup | [storagegroup.StorageGroup](#storagegroup.StorageGroup) | | StorageGroup contains meta information for the data audit |
| PublicKey | [PublicKey](#object.PublicKey) | | PublicKey of owner of the object. Key is used for verification and can be based on NeoID or x509 cert. |
[#26] object: Define message for object header In previous version of the format Object message included two header fields: SystemHeader and list of ExtendedHeader. Due to the fact that all headers were not encapsulated in a single message, some messages were forced to use Object to convey the full header of the object (e.g. object.HeadResponse). To resolve this semantic inconsistency, this commit defines a Header message, consisting of a system and an extended portion. As a result, the Object now consists of two fields - Header and Payload. Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-04 10:18:38 +00:00
<a name="object.Header"></a>
### Message Header
Header groups the information about the NeoFS object.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| SystemHeader | [SystemHeader](#object.SystemHeader) | | SystemHeader describes system header |
[#26] object: Remake ExtendedHeader to field set In previous version of the format ExtendedHeader consisted of one field Value, defined by oneof mechanism. Such a definition format give complete freedom when composing an object header, however, it did not allow strictly structuring the header format at the level of type syntax. Since the object has a well-defined structure in the system, this commit replaces the definition through oneof with a set of fields. As a consequence, storing a set of extended headers of the new type in the general header became redundant, so the repeated keyword was removed. Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-04 14:08:09 +00:00
| ExtendedHeader | [ExtendedHeader](#object.ExtendedHeader) | | ExtendedHeader carries the additional part of the header. |
[#26] object: Define message for object header In previous version of the format Object message included two header fields: SystemHeader and list of ExtendedHeader. Due to the fact that all headers were not encapsulated in a single message, some messages were forced to use Object to convey the full header of the object (e.g. object.HeadResponse). To resolve this semantic inconsistency, this commit defines a Header message, consisting of a system and an extended portion. As a result, the Object now consists of two fields - Header and Payload. Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-04 10:18:38 +00:00
initialize
2020-01-30 11:41:24 +00:00
<a name="object.IntegrityHeader"></a>
### Message IntegrityHeader
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| HeadersChecksum | [bytes](#bytes) | | HeadersChecksum is a checksum of all above headers in the object |
| ChecksumSignature | [bytes](#bytes) | | ChecksumSignature is an user's signature of checksum to verify if it is correct |
<a name="object.Link"></a>
### Message Link
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| type | [Link.Type](#object.Link.Type) | | Type of link |
| ID | [bytes](#bytes) | | ID is an object identifier, is a valid UUIDv4 |
<a name="object.Object"></a>
### Message Object
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
[#26] object: Define message for object header In previous version of the format Object message included two header fields: SystemHeader and list of ExtendedHeader. Due to the fact that all headers were not encapsulated in a single message, some messages were forced to use Object to convey the full header of the object (e.g. object.HeadResponse). To resolve this semantic inconsistency, this commit defines a Header message, consisting of a system and an extended portion. As a result, the Object now consists of two fields - Header and Payload. Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-04 10:18:38 +00:00
| Header | [Header](#object.Header) | | Header carries the object header. |
initialize
2020-01-30 11:41:24 +00:00
| Payload | [bytes](#bytes) | | Payload is an object's payload |
<a name="object.PublicKey"></a>
### Message PublicKey
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| Value | [bytes](#bytes) | | Value contains marshaled ecdsa public key |
[#26] object: Define object split info message This commit defines SplitHeader message that encapsulates data about spawning the object through a payload splitting. Message fields contain information about the hierarchy in the split-chain as well as information about the origin object. Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-04 13:04:56 +00:00
<a name="object.SplitHeader"></a>
### Message SplitHeader
SplitHeader groups information about spawning the object through a payload splitting.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| Parent | [refs.ObjectID](#refs.ObjectID) | | Parent carries identifier of the origin object. |
| Previous | [refs.ObjectID](#refs.ObjectID) | | Previous carries identifier of the left split neighbor. |
| Next | [refs.ObjectID](#refs.ObjectID) | | Previous carries identifier of the right split neighbor. |
| Children | [refs.ObjectID](#refs.ObjectID) | repeated | Children carries list of identifiers of the objects generated by splitting the current. |
| Origin | [Header](#object.Header) | | Origin carries the header of the origin object. |
initialize
2020-01-30 11:41:24 +00:00
<a name="object.SystemHeader"></a>
### Message SystemHeader
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| Version | [uint64](#uint64) | | Version of the object structure |
| PayloadLength | [uint64](#uint64) | | PayloadLength is an object payload length |
[#26] object: Combine ID and CID in Address This commit merges object system header fields ID and CID into field Address of type refs.Address. This will allow you to reuse an already existing type of object reference without duplication and simplify taking the address from the object body Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-04 12:33:10 +00:00
| Address | [refs.Address](#refs.Address) | | Address carries object address in the NeoFS system. It encapsulates the object and the container identifiers. |
initialize
2020-01-30 11:41:24 +00:00
| OwnerID | [bytes](#bytes) | | OwnerID is a wallet address |
[#26] object: Replace CreationPoint with Epoch In previous version of the format Object message included moment of creation in two epoch times: NeoFS and Unix. Since unix is not processed in the system, this commit narrows the time point of object creation to the system epoch number. The object.CreationPoint message has therefore been deleted as no longer used Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-04 12:10:44 +00:00
| CreationEpoch | [uint64](#uint64) | | CreationEpoch carries number of NeoFS epoch on which the object was created. |
initialize
2020-01-30 11:41:24 +00:00
<a name="object.Tombstone"></a>
### Message Tombstone
<!-- end messages -->
<a name="object.Link.Type"></a>
### Link.Type
| Name | Number | Description |
| ---- | ------ | ----------- |
| Unknown | 0 | |
| Parent | 1 | Parent object created during object transformation |
| Previous | 2 | Previous object in the linked list created during object transformation |
| Next | 3 | Next object in the linked list created during object transformation |
| Child | 4 | Child object created during object transformation |
| StorageGroup | 5 | Object that included into this storage group |
<!-- 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 |
Copy permalink