frostfs-api/refs/types.proto
Leonard Lyubich 2f5f6f8fde [#31] refs: Define ContainerID message
Define ContainerID message in refs package. In the future, this structure can be
ported into messages in place of the container identifier field to maintain
format uniformity. Also, storing the identifier in a dedicated message will
allow, if necessary, to expand it with additional information without losing
backward compatibility within one version of the API.

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-06 22:00:01 +03:00

31 lines
958 B
Protocol Buffer

syntax = "proto3";
package refs;
option go_package = "github.com/nspcc-dev/neofs-api-go/refs";
option csharp_namespace = "NeoFS.API.Refs";
import "github.com/gogo/protobuf/gogoproto/gogo.proto";
option (gogoproto.stable_marshaler_all) = true;
option (gogoproto.stringer_all) = false;
option (gogoproto.goproto_stringer_all) = false;
// Address of object (container id + object id)
message Address {
// ObjectID carries object identifier.
ObjectID ObjectID = 1;
// CID is container identifier
bytes CID = 2[(gogoproto.customtype) = "CID", (gogoproto.nullable) = false];
}
// ObjectID groups information about the NeoFS object identifier.
message ObjectID {
// Value carries the object identifier in a binary format.
bytes Value = 1;
}
// ContainerID groups information about the NeoFS container identifier.
message ContainerID {
// Value carries the container identifier in a binary format.
bytes Value = 1;
}