potyarkin/frostfs-api-go
1
0
Fork 0
forked from TrueCloudLab/frostfs-api-go
Code Pull requests Activity

[#13] *: Regenerate api

Browse source 
Signed-off-by: Denis Kirillov <d.kirillov@yadro.com>
This commit is contained in:
Denis Kirillov 2023-03-15 12:23:01 +03:00
parent cd2e46a17c
commit 8009022a20
8 changed files with 80 additions and 49 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
container/grpc/types.pb.go generated
View file

@ -131,16 +131,20 @@ func (x *Container) GetPlacementPolicy() *grpc1.PlacementPolicy {
//
// There are some "well-known" attributes affecting system behaviour:
//
// - [ __NEOFS__SUBNET | __FROSTFS__SUBNET ] \
// - [ __SYSTEM__SUBNET ] \
// (`__NEOFS__SUBNET` is deprecated) \
// String ID of a container's storage subnet. Any container can be attached to
// one subnet only.
// - [ __NEOFS__NAME | __FROSTFS__NAME ] \
// - [ __SYSTEM__NAME ] \
// (`__NEOFS__NAME` is deprecated) \
// String of a human-friendly container name registered as a domain in
// NNS contract.
// - [ __NEOFS__ZONE | __FROSTFS__ZONE ] \
// String of a zone for `__NEOFS__NAME`/`__FROSTFS__NAME`. Used as a TLD of a domain name in NNS
// - [ __SYSTEM__ZONE ] \
// (`__NEOFS__ZONE` is deprecated) \
// String of a zone for `__SYSTEM__NAME` (`__NEOFS__NAME` is deprecated). Used as a TLD of a domain name in NNS
// contract. If no zone is specified, use default zone: `container`.
// - [ __NEOFS__DISABLE_HOMOMORPHIC_HASHING | __FROSTFS__DISABLE_HOMOMORPHIC_HASHING ] \
// - [ __SYSTEM__DISABLE_HOMOMORPHIC_HASHING ] \
// (`__NEOFS__DISABLE_HOMOMORPHIC_HASHING` is deprecated) \
// Disables homomorphic hashing for the container if the value equals "true" string.
// Any other values are interpreted as missing attribute. Container could be
// accepted in a NeoFS network only if the global network hashing configuration

2
lock/grpc/types.pb.go generated
View file

@ -23,7 +23,7 @@ const (
// Lock objects protects a list of objects from being deleted. The lifetime of a
// lock object is limited similar to regular objects in
// `__NEOFS__EXPIRATION_EPOCH`/`__FROSTFS__EXPIRATION_EPOCH` attribute. Lock object MUST have expiration epoch.
// `__SYSTEM__EXPIRATION_EPOCH` (`__NEOFS__EXPIRATION_EPOCH` is deprecated) attribute. Lock object MUST have expiration epoch.
// It is impossible to delete a lock object via ObjectService.Delete RPC call.
type Lock struct {
state protoimpl.MessageState

3
netmap/grpc/types.pb.go generated
View file

@ -827,7 +827,8 @@ func (x *NetworkInfo) GetNetworkConfig() *NetworkConfig {
// attributes it's a string presenting floating point number with comma or
// point delimiter for decimal part. In the Network Map it will be saved as
// 64-bit unsigned integer representing number of minimal token fractions.
// - [ __NEOFS__SUBNET_%s | __FROSTFS__SUBNET_%s ] \
// - [ __SYSTEM__SUBNET_%s ] \
// (`__NEOFS__SUBNET_%s` is deprecated) \
// `True` or `False`. Defines if the node is included in the `%s` subnetwork
// or not. `%s` must be an existing subnetwork's ID (non-negative integer number).
// A node can be included in more than one subnetwork and, therefore, can contain

84
object/grpc/service_grpc.pb.go generated
View file

@ -30,11 +30,13 @@ type ObjectServiceClient interface {
// keeping the receiving order.
//
// Extended headers can change `Get` behaviour:
// - [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
// - [ __SYSTEM__NETMAP_EPOCH ] \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
// Will use the requsted version of Network Map for object placement
// calculation.
// - [ __NEOFS__NETMAP_LOOKUP_DEPTH | __FROSTFS__NETMAP_LOOKUP_DEPTH ] \
// Will try older versions (starting from `__NEOFS__NETMAP_EPOCH`/`__FROSTFS__NETMAP_EPOCH` if specified or
// - [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
// (`__NEOFS__NETMAP_LOOKUP_DEPTH` is deprecated) \
// Will try older versions (starting from `__SYSTEM__NETMAP_EPOCH` (`__NEOFS__NETMAP_EPOCH` is deprecated) if specified or
// the latest one otherwise) of Network Map to find an object until the depth
// limit is reached.
//
@ -63,7 +65,8 @@ type ObjectServiceClient interface {
// Chunk messages SHOULD be sent in the direct order of fragmentation.
//
// Extended headers can change `Put` behaviour:
// - [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH \
// - [ __SYSTEM__NETMAP_EPOCH \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
// Will use the requsted version of Network Map for object placement
// calculation.
//
@ -94,8 +97,9 @@ type ObjectServiceClient interface {
// guarantee. Object will be marked for removal and deleted eventually.
//
// Extended headers can change `Delete` behaviour:
// - [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
// Will use the requsted version of Network Map for object placement
// - [ __SYSTEM__NETMAP_EPOCH ] \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
// Will use the requested version of Network Map for object placement
// calculation.
//
// Please refer to detailed `XHeader` description.
@ -118,8 +122,9 @@ type ObjectServiceClient interface {
// the very minimal information will be returned instead.
//
// Extended headers can change `Head` behaviour:
// - [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
// Will use the requsted version of Network Map for object placement
// - [ __SYSTEM__NETMAP_EPOCH ] \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
// Will use the requested version of Network Map for object placement
// calculation.
//
// Please refer to detailed `XHeader` description.
@ -144,8 +149,9 @@ type ObjectServiceClient interface {
// Specification section for more details.
//
// Extended headers can change `Search` behaviour:
// - [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
// Will use the requsted version of Network Map for object placement
// - [ __SYSTEM__NETMAP_EPOCH ] \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
// Will use the requested version of Network Map for object placement
// calculation.
//
// Please refer to detailed `XHeader` description.
@ -167,10 +173,12 @@ type ObjectServiceClient interface {
// order.
//
// Extended headers can change `GetRange` behaviour:
// - [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
// Will use the requsted version of Network Map for object placement
// - [ __SYSTEM__NETMAP_EPOCH ] \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
// Will use the requested version of Network Map for object placement
// calculation.
// - [ __NEOFS__NETMAP_LOOKUP_DEPTH | __FROSTFS__NETMAP_LOOKUP_DEPTH ] \
// - [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
// (`__NEOFS__NETMAP_LOOKUP_DEPTH` is deprecated) \
// Will try older versions of Network Map to find an object until the depth
// limit is reached.
//
@ -199,10 +207,12 @@ type ObjectServiceClient interface {
// the request. Note that hash is calculated for XORed data.
//
// Extended headers can change `GetRangeHash` behaviour:
// - [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
// Will use the requsted version of Network Map for object placement
// - [ __SYSTEM__NETMAP_EPOCH ] \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
// Will use the requested version of Network Map for object placement
// calculation.
// - [ __NEOFS__NETMAP_LOOKUP_DEPTH | __FROSTFS__NETMAP_LOOKUP_DEPTH ] \
// - [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
// (`__NEOFS__NETMAP_LOOKUP_DEPTH` is deprecated) \
// Will try older versions of Network Map to find an object until the depth
// limit is reached.
//
@ -402,11 +412,13 @@ type ObjectServiceServer interface {
// keeping the receiving order.
//
// Extended headers can change `Get` behaviour:
// - [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
// - [ __SYSTEM__NETMAP_EPOCH ] \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
// Will use the requsted version of Network Map for object placement
// calculation.
// - [ __NEOFS__NETMAP_LOOKUP_DEPTH | __FROSTFS__NETMAP_LOOKUP_DEPTH ] \
// Will try older versions (starting from `__NEOFS__NETMAP_EPOCH`/`__FROSTFS__NETMAP_EPOCH` if specified or
// - [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
// (`__NEOFS__NETMAP_LOOKUP_DEPTH` is deprecated) \
// Will try older versions (starting from `__SYSTEM__NETMAP_EPOCH` (`__NEOFS__NETMAP_EPOCH` is deprecated) if specified or
// the latest one otherwise) of Network Map to find an object until the depth
// limit is reached.
//
@ -435,7 +447,8 @@ type ObjectServiceServer interface {
// Chunk messages SHOULD be sent in the direct order of fragmentation.
//
// Extended headers can change `Put` behaviour:
// - [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH \
// - [ __SYSTEM__NETMAP_EPOCH \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
// Will use the requsted version of Network Map for object placement
// calculation.
//
@ -466,8 +479,9 @@ type ObjectServiceServer interface {
// guarantee. Object will be marked for removal and deleted eventually.
//
// Extended headers can change `Delete` behaviour:
// - [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
// Will use the requsted version of Network Map for object placement
// - [ __SYSTEM__NETMAP_EPOCH ] \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
// Will use the requested version of Network Map for object placement
// calculation.
//
// Please refer to detailed `XHeader` description.
@ -490,8 +504,9 @@ type ObjectServiceServer interface {
// the very minimal information will be returned instead.
//
// Extended headers can change `Head` behaviour:
// - [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
// Will use the requsted version of Network Map for object placement
// - [ __SYSTEM__NETMAP_EPOCH ] \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
// Will use the requested version of Network Map for object placement
// calculation.
//
// Please refer to detailed `XHeader` description.
@ -516,8 +531,9 @@ type ObjectServiceServer interface {
// Specification section for more details.
//
// Extended headers can change `Search` behaviour:
// - [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
// Will use the requsted version of Network Map for object placement
// - [ __SYSTEM__NETMAP_EPOCH ] \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
// Will use the requested version of Network Map for object placement
// calculation.
//
// Please refer to detailed `XHeader` description.
@ -539,10 +555,12 @@ type ObjectServiceServer interface {
// order.
//
// Extended headers can change `GetRange` behaviour:
// - [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
// Will use the requsted version of Network Map for object placement
// - [ __SYSTEM__NETMAP_EPOCH ] \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
// Will use the requested version of Network Map for object placement
// calculation.
// - [ __NEOFS__NETMAP_LOOKUP_DEPTH | __FROSTFS__NETMAP_LOOKUP_DEPTH ] \
// - [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
// (`__NEOFS__NETMAP_LOOKUP_DEPTH` is deprecated) \
// Will try older versions of Network Map to find an object until the depth
// limit is reached.
//
@ -571,10 +589,12 @@ type ObjectServiceServer interface {
// the request. Note that hash is calculated for XORed data.
//
// Extended headers can change `GetRangeHash` behaviour:
// - [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
// Will use the requsted version of Network Map for object placement
// - [ __SYSTEM__NETMAP_EPOCH ] \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
// Will use the requested version of Network Map for object placement
// calculation.
// - [ __NEOFS__NETMAP_LOOKUP_DEPTH | __FROSTFS__NETMAP_LOOKUP_DEPTH ] \
// - [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
// (`__NEOFS__NETMAP_LOOKUP_DEPTH` is deprecated) \
// Will try older versions of Network Map to find an object until the depth
// limit is reached.
//

14
object/grpc/types.pb.go generated
View file

@ -556,19 +556,23 @@ func (x *SplitInfo) GetLink() *grpc.ObjectID {
// Objects with duplicated attribute names or attributes with empty values
// will be considered invalid.
//
// There are some "well-known" attributes starting with `__NEOFS__`/`__FROSTFS__` prefix
// There are some "well-known" attributes starting with `__SYSTEM__` (`__NEOFS__` is deprecated) prefix
// that affect system behaviour:
//
// - [ __NEOFS__UPLOAD_ID | __FROSTFS__UPLOAD_ID ] \
// - [ __SYSTEM__UPLOAD_ID ] \
// (`__NEOFS__UPLOAD_ID` is deprecated) \
// Marks smaller parts of a split bigger object
// - [ __NEOFS__EXPIRATION_EPOCH | __FROSTFS__EXPIRATION_EPOCH ] \
// - [ __SYSTEM__EXPIRATION_EPOCH ] \
// (`__NEOFS__EXPIRATION_EPOCH` is deprecated) \
// Tells GC to delete object after that epoch
// - [ __NEOFS__TICK_EPOCH | __FROSTFS__TICK_EPOCH ] \
// - [ __SYSTEM__TICK_EPOCH ] \
// (`__NEOFS__TICK_EPOCH` is deprecated) \
// Decimal number that defines what epoch must produce
// object notification with UTF-8 object address in a
// body (`0` value produces notification right after
// object put)
// - [ __NEOFS__TICK_TOPIC | __FROSTFS__TICK_TOPIC ] \
// - [ __SYSTEM__TICK_TOPIC ] \
// (`__NEOFS__TICK_TOPIC` is deprecated) \
// UTF-8 string topic ID that is used for object notification
//
// And some well-known attributes used by applications only:

8
session/grpc/types.pb.go generated
View file

@ -349,14 +349,16 @@ func (x *SessionToken) GetSignature() *grpc.Signature {
// Responses with duplicated header names or headers with empty values will be
// considered invalid.
//
// There are some "well-known" headers starting with `__NEOFS__` or `__FROSTFS__` prefix that
// There are some "well-known" headers starting with `__SYSTEM__` (`__NEOFS__` is deprecated) prefix that
// affect system behaviour:
//
// - [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
// - [ __SYSTEM__NETMAP_EPOCH ] \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
// Netmap epoch to use for object placement calculation. The `value` is string
// encoded `uint64` in decimal presentation. If set to '0' or not set, the
// current epoch only will be used.
// - [ __NEOFS__NETMAP_LOOKUP_DEPTH | __FROSTFS__NETMAP_LOOKUP_DEPTH ] \
// - [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
// (`__NEOFS__NETMAP_LOOKUP_DEPTH` is deprecated) \
// If object can't be found using current epoch's netmap, this header limits
// how many past epochs the node can look up through. The `value` is string
// encoded `uint64` in decimal presentation. If set to '0' or not set, only the

2
storagegroup/grpc/types.pb.go generated
View file

@ -27,7 +27,7 @@ const (
// contains objects from the same container.
//
// Being an object payload, StorageGroup may have expiration Epoch set with
// `__NEOFS__EXPIRATION_EPOCH`/`__FROSTFS__EXPIRATION_EPOCH` well-known attribute. When expired, StorageGroup
// `__SYSTEM__EXPIRATION_EPOCH` (`__NEOFS__EXPIRATION_EPOCH` is deprecated) well-known attribute. When expired, StorageGroup
// will be ignored by InnerRing nodes during Data Audit cycles and will be
// deleted by Storage Nodes.
type StorageGroup struct {

2
tombstone/grpc/types.pb.go generated
View file

@ -30,7 +30,7 @@ type Tombstone struct {
// Last NeoFS epoch number of the tombstone lifetime. It's set by the tombstone
// creator depending on the current NeoFS network settings. A tombstone object
// must have the same expiration epoch value in `__NEOFS__EXPIRATION_EPOCH`/`__FROSTFS__EXPIRATION_EPOCH`
// must have the same expiration epoch value in `__SYSTEM__EXPIRATION_EPOCH` (`__NEOFS__EXPIRATION_EPOCH` is deprecated)
// attribute. Otherwise, the tombstone will be rejected by a storage node.
ExpirationEpoch uint64 `protobuf:"varint,1,opt,name=expiration_epoch,json=expirationEpoch,proto3" json:"expiration_epoch,omitempty"`
// 16 byte UUID used to identify the split object hierarchy parts. Must be