frostfs-api/container/types.proto

syntax = "proto3";
package container;
option go_package = "github.com/nspcc-dev/neofs-api-go/container";
option csharp_namespace = "NeoFS.API.Container";

import "refs/types.proto";
import "github.com/nspcc-dev/netmap/selector.proto";
import "github.com/gogo/protobuf/gogoproto/gogo.proto";

option (gogoproto.stable_marshaler_all) = true;

// Container is a structure that defines object placement behaviour. Objects
// can be stored only within containers. They define placement rule, attributes
// and access control information. ID of the container is a 32 byte long
// SHA256 hash of stable-marshalled container message.
message Container {
  // OwnerID carries identifier of the container owner.
  refs.OwnerID OwnerID = 1;
  // Nonce is a 16 byte UUID, used to avoid collisions of container id.
  bytes Nonce                   = 2;
  // BasicACL contains access control rules for owner, system, others groups and
  // permission bits for bearer token and Extended ACL.
  uint32 BasicACL               = 3;
  // Attributes define any immutable characteristics of container.
  repeated Attribute Attributes = 4;
  // Rules define storage policy for the object inside the container.
  netmap.PlacementRule Rules    = 5;
}

// Attribute is a key-value pair of strings.
message Attribute {
  // Key of immutable container attribute.
  string Key   = 1;
  // Value of immutable container attribute.
  string Value = 2;
}