# Protocol Documentation ## 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) - [SearchRequest](#object.SearchRequest) - [SearchResponse](#object.SearchResponse) - [object/types.proto](#object/types.proto) - Messages - [CreationPoint](#object.CreationPoint) - [Header](#object.Header) - [IntegrityHeader](#object.IntegrityHeader) - [Link](#object.Link) - [Object](#object.Object) - [Range](#object.Range) - [StorageGroup](#object.StorageGroup) - [StorageGroup.Lifetime](#object.StorageGroup.Lifetime) - [SystemHeader](#object.SystemHeader) - [Tombstone](#object.Tombstone) - [Transform](#object.Transform) - [UserHeader](#object.UserHeader) - [Scalar Value Types](#scalar-value-types)

Top

## object/service.proto ### 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); rpc Search(SearchRequest) returns (SearchResponse); rpc GetRange(GetRangeRequest) returns (GetRangeResponse); 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 package). | Name | Input | Output | | ---- | ----- | ------ | | Search | [SearchRequest](#object.SearchRequest) | [SearchResponse](#object.SearchResponse) | #### Method GetRange GetRange of data payload. Ranges are set of pairs (offset, length). Fragments order in response corresponds to ranges order in request. | 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) | ### Message DeleteRequest | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value | | Address | [refs.Address](#refs.Address) | | Address of object (container id + object id) | | OwnerID | [bytes](#bytes) | | OwnerID is a wallet address | | TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node | | Token | [session.Token](#session.Token) | | Token with session public key and user's signature | ### Message DeleteResponse DeleteResponse is empty because we cannot guarantee permanent object removal in distributed system. ### Message GetRangeHashRequest | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value | | 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 | | TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node | ### Message GetRangeHashResponse | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | Hashes | [bytes](#bytes) | repeated | Homomorphic hashes of all ranges | ### Message GetRangeRequest | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value | | Address | [refs.Address](#refs.Address) | | Address of object (container id + object id) | | Ranges | [Range](#object.Range) | repeated | Ranges of object's payload to return | | TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node | ### Message GetRangeResponse | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | Fragments | [bytes](#bytes) | repeated | Fragments of object's payload | ### Message GetRequest | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value | | Address | [refs.Address](#refs.Address) | | Address of object (container id + object id) | | TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node | ### Message GetResponse | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | object | [Object](#object.Object) | | Object header and some payload | | Chunk | [bytes](#bytes) | | Chunk of remaining payload | ### Message HeadRequest | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value | | 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 | | TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node | ### Message HeadResponse | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | Object | [Object](#object.Object) | | Object without payload | ### 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 | ### Message PutRequest.PutHeader | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value | | Object | [Object](#object.Object) | | Object with at least container id and owner id fields | | TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node | | Token | [session.Token](#session.Token) | | Token with session public key and user's signature | ### Message PutResponse | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | Address | [refs.Address](#refs.Address) | | Address of object (container id + object id) | ### Message SearchRequest | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value | | Version | [uint32](#uint32) | | Version of search query format | | ContainerID | [bytes](#bytes) | | ContainerID for searching the object | | Query | [bytes](#bytes) | | Query in the binary serialized format | | TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node | ### Message SearchResponse | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | Addresses | [refs.Address](#refs.Address) | repeated | Addresses of found objects |

Top

## object/types.proto ### Message CreationPoint | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | UnixTime | [int64](#int64) | | Date of creation in unixtime format | | Epoch | [uint64](#uint64) | | Date of creation in NeoFS epochs | ### Message Header | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | Link | [Link](#object.Link) | | Link to other objects | | Redirect | [refs.Address](#refs.Address) | | RedirectNot used yet | | UserHeader | [UserHeader](#object.UserHeader) | | UserHeader defined by user | | Transform | [Transform](#object.Transform) | | Transform defines transform operation (e.g. payload split) | | Tombstone | [Tombstone](#object.Tombstone) | | Tombstone header that set up in deleted objects | | Verify | [session.VerificationHeader](#session.VerificationHeader) | | Verify header that contains session public key and user's signature | | HomoHash | [bytes](#bytes) | | 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](#object.StorageGroup) | | StorageGroup contains meta information for the data audit | ### Message IntegrityHeader | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | HeadersChecksum | [bytes](#bytes) | | Checksum of all above headers in the object | | ChecksumSignature | [bytes](#bytes) | | User's signature of checksum to verify if it is correct | ### Message Link | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | type | [Link.Type](#object.Link.Type) | | Link type | | ID | [bytes](#bytes) | | Object id | ### Message Object | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | SystemHeader | [SystemHeader](#object.SystemHeader) | | System header | | Headers | [Header](#object.Header) | repeated | Extended headers | | Payload | [bytes](#bytes) | | Object's payload | ### Message Range | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | Offset | [uint64](#uint64) | | Offset of the data range | | Length | [uint64](#uint64) | | Length of the data range | ### Message StorageGroup | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | ValidationDataSize | [uint64](#uint64) | | Size of the all object's payloads included into storage group | | ValidationHash | [bytes](#bytes) | | Homomorphic hash of all object's payloads included into storage group | | lifetime | [StorageGroup.Lifetime](#object.StorageGroup.Lifetime) | | Time until storage group is valid | ### Message StorageGroup.Lifetime | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | unit | [StorageGroup.Lifetime.Unit](#object.StorageGroup.Lifetime.Unit) | | Lifetime type | | Value | [int64](#int64) | | Lifetime value | ### Message SystemHeader | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | Version | [uint64](#uint64) | | Version of the object structure | | PayloadLength | [uint64](#uint64) | | Object payload length | | ID | [bytes](#bytes) | | ObjectID is a UUID | | OwnerID | [bytes](#bytes) | | OwnerID is a wallet address | | CID | [bytes](#bytes) | | ContainerID is a SHA256 hash of the container structure | | CreatedAt | [CreationPoint](#object.CreationPoint) | | Timestamp of object creation | ### Message Tombstone | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | Epoch | [uint64](#uint64) | | Epoch when tombstone was created | ### Message Transform | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | type | [Transform.Type](#object.Transform.Type) | | Type of object transformation | ### Message UserHeader | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | Key | [string](#string) | | Key of the user's header | | Value | [string](#string) | | Value of the user's header | ### 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 | ### StorageGroup.Lifetime.Unit | Name | Number | Description | | ---- | ------ | ----------- | | Unlimited | 0 | Storage group always valid | | NeoFSEpoch | 1 | Storage group is valid until lifetime NeoFS epoch | | UnixTime | 2 | Storage group is valid until lifetime unix timestamp | ### Transform.Type | Name | Number | Description | | ---- | ------ | ----------- | | Unknown | 0 | | | Split | 1 | Object created after payload split | | Sign | 2 | Object created after re-signing (doesn't used) | | Mould | 3 | Object created after filling missing headers in the object | ## 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 |